- Fix: Save broken on Firefox (since FF version?)
- Docs: Mention potentially more frequent release schedule - Docs (ReleaseInstructions): Update per new testing; update `grep-doc` -> `types-doc` and indicate current failing status; indicate when `build-doc` will be used; clarify `npm pack` - npm: Add newly renamed `jsdoc-check-overly-generic-types.js` to ignore - npm: Bump to 3.1.1
This commit is contained in:
@@ -2,18 +2,24 @@
|
||||
|
||||
## Prepare
|
||||
|
||||
1. `npm test` - Ensure build steps occur and tests are passing
|
||||
1. `npm run build-doc` - Ensure JSDoc can build and is available for site build
|
||||
1. `npm run grep-doc` - For JSDoc, we ensure that a minimum of generic types
|
||||
1. `npm run browser-test` - Ensure build steps occur and tests are passing
|
||||
1. `npm test` - This should also be run, though currently accessibility tests
|
||||
are failing
|
||||
1. `npm run build-doc` - Ensure JSDoc can build and is available for site
|
||||
build (though not added to `master`, will be copied over in `gh-pages`
|
||||
steps and used in `npm publish` step).
|
||||
1. `npm run types-doc` - For JSDoc, we ensure that a minimum of generic types
|
||||
have been added (e.g., "number" should instead be "Float" or "Array",
|
||||
and "object", "function", or "array" should be replaced by more specific
|
||||
`@interface`s, `@typdef`s, or `@callback`. Deriving types can use
|
||||
`PlainObject` or `GenericArray` to indicate the simple base type was
|
||||
intentional. `*` should also be checked. The script reports all failing
|
||||
matches within `editor`. There should be none.
|
||||
1. Preview which files will be included once published (taking into
|
||||
account `.npmignore`), by using `npm pack` (taking care to remove
|
||||
the `.tgz` tarball file that it creates).
|
||||
matches within `editor`. There should be none (there is currently one
|
||||
due to our needing to move the file to its own module).
|
||||
1. `npm pack` to preview which files will be included once published and
|
||||
taking into account `.npmignore`. Take care to remove the `.tgz` tarball
|
||||
file that it creates so it is not itself included during the
|
||||
publishing step.
|
||||
|
||||
## Update the main project
|
||||
<!--
|
||||
|
||||
@@ -9,6 +9,9 @@ Please see the CHANGES file (or the Git history or Github tracker) for more
|
||||
detailed descriptions of individual changes than that provided by the
|
||||
below summaries.
|
||||
|
||||
Concomitant with switching to npm (semantic) versioning, future releases
|
||||
should be added for any changes on a more frequent schedule.
|
||||
|
||||
## Breaking changes
|
||||
|
||||
There were also the following breaking changes. Not included among these are
|
||||
|
||||
Reference in New Issue
Block a user