Skip to content
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

Merged
merged 4 commits into from Nov 25, 2020
Merged

Conversation

aaronayres35
Copy link
Contributor

This PR simply tries to clean up some markdown issues in the newly added release checklist issue template.

motivated by this comment: #371 (comment)

@rahulporuri
Copy link
Contributor

rahulporuri commented Nov 25, 2020

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.

preview-md-vscode

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

@aaronayres35
Copy link
Contributor Author

if you're using VS Code, there is a "Preview" option that will render the markdown in the editor.

This is extremely useful, thank you!

Copy link
Contributor

@rahulporuri rahulporuri left a 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`
Copy link
Contributor

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.

aaronayres35 and others added 2 commits November 25, 2020 10:49
@aaronayres35 aaronayres35 merged commit 99a429f into master Nov 25, 2020
@aaronayres35 aaronayres35 deleted the cleanup-release-template branch November 25, 2020 17:07
@rahulporuri rahulporuri moved this from In Progress to Done in Enthought OSS Q4 2020 Nov 25, 2020
@rahulporuri rahulporuri moved this from Done to Sprint 4 : Nov 16 - Nov 27 2020 in Enthought OSS Q4 2020 Nov 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Enthought OSS Q4 2020
Sprint 4 : Nov 16 - Nov 27 2020
Development

Successfully merging this pull request may close these issues.

None yet

2 participants