- Breaking change: Switch from deprecated @babel/polyfill to

`core-js-bundle` and `regenerator-runtime` replacements
- Fix: Fully redirect extension entrances for lacking browser support
- Docs: Simplify comments in HTML files re: script purposes
- Docs: Update release instructions
- npm: Update devDeps (jsdoc, security audit)
- npm: Bump to 5.0.0
This commit is contained in:
Brett Zamir
2019-05-06 12:32:49 +08:00
parent 0f4b739143
commit fc0c53f61a
20 changed files with 1017 additions and 7332 deletions

View File

@@ -3,12 +3,12 @@
## Prepare
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
1. `npm start` and in another console window, `npm test` - This should
also be run, though currently accessibility tests are failing.
1. `npm run build-docs` - 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
1. `npm run types-docs` - 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
@@ -16,10 +16,8 @@
intentional. `*` should also be checked. The script reports all failing
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.
1. `npm pack --dry-run` to preview which files will be included once
published and taking into account `.npmignore`.
## Update the main project
<!--
@@ -30,7 +28,7 @@
1. Add new release info to `Recent news` section in README
1. Commit these changes
<!-- with `git commit -m "Updating Makefile and CHANGES for release X.Y.Z"`-->.
1. Tag the version, prefixed by "v", e.g., `v4.0.1`.
1. Tag the version, prefixed by "v", e.g., `v5.0.1`.
The above steps can be done on a fork and committed via a pull request.

View File

@@ -8,7 +8,7 @@ Some API changes also involve switching to class methods over instance
methods, though these were private/internally used APIs.
Please see the CHANGES file (or the Git history or Github tracker) for
fixes and enhancements.
more fixes and enhancements.
## Breaking changes

17
docs/versions/5.0.0.md Normal file
View File

@@ -0,0 +1,17 @@
# Version 5.0.0
This release should require minimal updating.
Contains a few fixes for PHP-related extensions.
Please see the CHANGES file (or the Git history or Github tracker) for
more fixes and enhancements.
## Breaking changes
- The HTML files have switched from the now deprecated `@babel/polyfill`
to `core-js-bundle` and `regenerator-runtime` replacements. If you
have not modified the HTML and are updating via npm, this change
should have no effect. (`@babel/polyfill` is still required through
some of the dependencies, but this is expected to eventually change.)
- If you are running build files, you will now need at least Node 8.5