Skip to content
GitLab

Release process checklist · Changes

Page history
Minor Update following CDN retirement authored by Peter Krautzberger's avatar Peter Krautzberger
Show whitespace changes
Inline Side-by-side
Release-process-checklist.md
View page @ 600ca913
...@@ -13,25 +13,20 @@ ...@@ -13,25 +13,20 @@
4. The release is tagged on GitHub with a tag name such as `N.m.p` (for beta releases, we tag from `develop`); follow the example of preceding release notes. 4. The release is tagged on GitHub with a tag name such as `N.m.p` (for beta releases, we tag from `develop`); follow the example of preceding release notes.
6. The distribution should then be downloaded and smoke tested. 6. The distribution should then be downloaded and smoke tested.
### At CDN ### CDNs
Reference: https://github.com/mathjax/MathJax/wiki/CDN-Hosting-at-Google-Cloud-Storage CDN providers (cdnjs, rawgit) will pick up tagged releases automatically.
1. The GCS buckets are: `cdn.mathjax.org` for regular releases & `beta.mathjax.org` for beta releases
1. Create or update `mathjax/N.m-latest/` and update `mathjax/latest/` -- unless it's a patch release for an older version, then just update `mathjax/N.m-latest`.
1. When fonts change, you'll need to [fix mime-type headers](https://github.com/mathjax/MathJax/wiki/CDN-Hosting-at-Google-Cloud-Storage#mime-type-headers). If there were no updates, it's faster to copy the fonts from `latest` to `N.m-latest` [in the cloud](https://github.com/mathjax/MathJax/wiki/CDN-Hosting-at-Google-Cloud-Storage#copying).
1. If updated, check the custom headers of fonts (e.g., via curl).
1. Purge the cache: it seems CloudFlare picks up changes to GCS immediately. But to be sure, purge the changed files or the entire CDN via the CloudFlare Web Interface.
**Note.** We no longer provide our own CDN service, cf. https://www.mathjax.org/cdn-shutting-down/.
### At mathjax.org ### At mathjax.org
1. For major and minor releases, a news announcement for the release is posted. The post should follow the announcement for previous versions, in particular 1. For major and minor releases (and important bug fix releases), a news announcement for the release is posted. The post should follow the announcement for previous versions, in particular
* Summary of what changed in the release * Summary of what changed in the release
* Advise regarding the CDN propagation (clear browser cache etc) * Advise regarding the CDN propagation (clear browser cache etc)
* Point to the release * Point to the release
* Give instructions for reporting bugs, and refer questions to MathJax Users * Give instructions for reporting bugs, and refer questions to MathJax Users
* A copy of the What's new document from the documenation * A copy of the What's new document from the documentation
2. Extract from this a press release (again, follow previous examples). 2. Extract from this a press release (again, follow previous examples).
### For the community ### For the community
......