Add `updatestatic` gulp command (#102)

This commit is contained in:
Christopher C. Wells 2020-01-27 19:48:28 -08:00
parent fd05659fe8
commit c9b9ad543d
2 changed files with 18 additions and 11 deletions

View File

@ -9,7 +9,6 @@
- [Development](#development) - [Development](#development)
- [Installation](#installation) - [Installation](#installation)
- [Gulp Commands](#gulp-commands) - [Gulp Commands](#gulp-commands)
- [Pre-commit Hook](#pre-commit-hook)
## Contributions ## Contributions
@ -73,7 +72,7 @@ the language. If it does:
`scriptsConfig.graph`. `scriptsConfig.graph`.
1. Build, collect, and commit the `/static` folder (see 1. Build, collect, and commit the `/static` folder (see
[`gulp collectstatic`](#collectstatic)). [`gulp updatestatic`](#updatestatic)).
1. Run the development server, log in, and update the user language to test the 1. Run the development server, log in, and update the user language to test the
newly translated strings. newly translated strings.
@ -81,7 +80,6 @@ newly translated strings.
Once the translation is complete, commit the new files and changes to a fork Once the translation is complete, commit the new files and changes to a fork
and [create a pull request](#pull-request-process) for review. and [create a pull request](#pull-request-process) for review.
For more information on the Django translation process, see Django's For more information on the Django translation process, see Django's
documentation section: [Translation](https://docs.djangoproject.com/en/3.0/topics/i18n/translation/). documentation section: [Translation](https://docs.djangoproject.com/en/3.0/topics/i18n/translation/).
@ -156,6 +154,7 @@ in the [`babybuddy/management/commands`](babybuddy/management/commands) folder.
- [`gulp scripts`](#scripts) - [`gulp scripts`](#scripts)
- [`gulp styles`](#styles) - [`gulp styles`](#styles)
- [`gulp test`](#test) - [`gulp test`](#test)
- [`gulp updatestatic`](#updatestatic)
#### `gulp` #### `gulp`
@ -181,14 +180,7 @@ the `babybuddy/static` folder, so generally `gulp build` should be run before
this command for production deployments. Gulp also passes along this command for production deployments. Gulp also passes along
non-overlapping arguments for this command, e.g. `--no-input`. non-overlapping arguments for this command, e.g. `--no-input`.
Before executing this command, ensure that Note: a `SECRET_KEY` value must be set for this command to work.
- `DEBUG` is set to it's default (`False`).
- `STATICFILES_STORAGE` is set to it's default.
- `SECRET_KEY` is set to (anything).
See the [`development.py` settings file](babybuddy/settings/development.py) for
additional information.
#### `compilemessages` #### `compilemessages`
@ -266,3 +258,16 @@ Executes Baby Buddy's suite of tests.
Gulp also passes along non-overlapping arguments for this command, however Gulp also passes along non-overlapping arguments for this command, however
individual tests cannot be run with this command. `python manage.py test` can be individual tests cannot be run with this command. `python manage.py test` can be
used for individual test execution. used for individual test execution.
#### `updatestatic`
Rebuilds Baby Buddy's `/static` folder by running the following commands in
order:
- [`lint`](#lint)
- [`clean`](#clean)
- [`build`](#build)
- [`collectstatic`](#collectstatic)
This command should be executed, and any changes committed, any time changes
are made to Baby Buddy's frontend code (SASS, JS, etc.).

View File

@ -243,4 +243,6 @@ gulp.task('runserver', function(cb) {
spawn('pipenv', command, { stdio: 'inherit' }).on('exit', cb); spawn('pipenv', command, { stdio: 'inherit' }).on('exit', cb);
}); });
gulp.task('updatestatic', gulp.series('lint', 'clean', 'build', 'collectstatic'));
gulp.task('default', gulp.series('build', gulp.parallel(watch, 'runserver'))); gulp.task('default', gulp.series('build', gulp.parallel(watch, 'runserver')));