New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Cleanup Release Issue Template #372
Conversation
if you're using VS Code, there is a "Preview" option that will render the markdown in the editor. That should make it easier to experiment rather than pushing the changes to github and seeing how GitHub renders it. that icon should be visible in the top-right corner of the editor. Ref https://code.visualstudio.com/Docs/languages/markdown#_dynamic-previews-and-preview-locking |
This is extremely useful, thank you! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mostly LGTM. The template renders as expected.
- [ ] Open and merge a PR against `maint/<release version number>` | ||
- [ ] Create a new branch from `maint/<release version number>`, Flip `IS_RELEASED` back to false, commit. | ||
- [ ] Open and merge another PR against `maint/<release version number>` | ||
- [ ] Tag (annotated!) the release candidate on the commit where IS_RELEASED is set to true, e.g. `git tag -a -m "Release candidate <release version number>rc1" <release version number>rc1 <commit-hash>` | ||
- [ ] Push the tag to GitHub | ||
- [ ] Upload to PyPI | ||
- `git checkout <tag>`, `git clean -ffxd`, `python setup.py sdist`, `twine check dist/<...>.tar.gz`, `twine upload dist/<...>.tar.gz` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Release blockers
section doesn't get rendered correctly because it's just - [ ]
. It might be useful to add a few words there.
Co-authored-by: Poruri Sai Rahul <rporuri@enthought.com>
This PR simply tries to clean up some markdown issues in the newly added release checklist issue template.
motivated by this comment: #371 (comment)