-
Notifications
You must be signed in to change notification settings - Fork 4k
Release checklist
Reuben Morais edited this page May 26, 2020
·
16 revisions
- Create release branch in https://github.com/mozilla/DeepSpeech-examples
- Uplift new examples and modifications in latest stable branch into master
- Make any modifications necessary for compatibility with new DS version
- Branch from master into new release branch (e.g. r0.8 for DS v0.8.x, or r1.0 for DS v1.0.x)
- Create release branch in https://github.com/mozilla/DeepSpeech
- Branch from master into new release branch (e.g. r0.8 for DS v0.8.x, or r1.0 for DS v1.0.x)
- Push new branch with no extra commits to GitHub
- Change
.taskcluster.yml
andtaskcluster/github-events.cyml
to mention the new branch instead of master - Change
EXAMPLES_CHECKOUT_TARGET
intaskcluster/win-opt-base.tyml
andexamples-base.tyml
to checkout the new release branch instead of master - Make a PR with above changes and make sure CI works
- Merge PR into new release branches
- Make a new alpha tag to test tag CI
- Update release notes in draft release
- Update hyperparameters in draft release
- Update contributor list in draft release
- Package and upload checkpoint, models, and audio examples
- Remember to include alphabet.txt in checkpoint package, as it's no longer needed for the models
- If packaging from a best_dev checkpoint,
cp best_dev_checkpoint checkpoint
to avoid problems when loading the checkpoint from code that doesn't handle the separate checkpoint/best_dev_checkpoint logic
- Upload models somewhere else (e.g. personal fork release) and link prod model tests and examples tests to new URLs
- Update all references to previous release in documentation
- Bump VERSION file to new version, remove note from README.rst about "This documentation applies to the master branch of DeepSpeech only. [...]".
- Merge PR bumping VERSION file, then tag new version on the merge commit
- Push the tag
- Publish the draft release pointing to the existing tag
- Monitor task group created from the tag to make sure everything is built and published
- Manually check package repositories after publish is complete
- https://pypi.org/project/deepspeech/
- https://pypi.org/project/deepspeech-tflite/
- https://pypi.org/project/deepspeech-gpu/
- https://www.npmjs.com/package/deepspeech
- https://www.npmjs.com/package/deepspeech-tflite
- https://www.npmjs.com/package/deepspeech-gpu
- https://www.nuget.org/packages/DeepSpeech
- https://www.nuget.org/packages/DeepSpeech-TFLite
- https://www.nuget.org/packages/DeepSpeech-GPU
- Make the new version the default on https://deepspeech.readthedocs.io/
- Make the new version the default on https://github.com/mozilla/DeepSpeech-examples
- Add the notice about "This documentation applies to the master branch of DeepSpeech only. [...]" to README.rst again
Don't edit this footer for questions, add them to the page with the edit button at the top.