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

[chore] Document release workflow #58

Closed
hamlim opened this issue Apr 26, 2024 · 5 comments
Closed

[chore] Document release workflow #58

hamlim opened this issue Apr 26, 2024 · 5 comments
Labels
documentation Improvements or additions to documentation stale

Comments

@hamlim
Copy link
Collaborator

hamlim commented Apr 26, 2024

Benefit:

Future contributors know how to make a new release (and publish to NPM) when necessary

Deliverable:

Add a section to the Contributing guidelines for how the release workflow works

@hamlim hamlim added the documentation Improvements or additions to documentation label Apr 26, 2024
@hamlim
Copy link
Collaborator Author

hamlim commented Apr 26, 2024

As I understand the workflow I think we need to do the following:

  • Make changes
  • Document those changes in the Unreleased section of the Changelog
  • When we're ready for a release we;
    • Move all the unreleased changelogs under a new heading for the new version
    • Bump the version in package.json
    • Get this reviewed and merged into main
    • Start a new release from GitHub.com (creating a new git tag for the version we're releasing, e.g. v0.7.0)
    • Fill out the GitHub release info and submit

I think at that point the release GitHub action will run and publish the package to NPM!

Copy link

Automatically marking issue as stale due to lack of activity

@github-actions github-actions bot added the stale label Jun 30, 2024
@hamlim
Copy link
Collaborator Author

hamlim commented Jun 30, 2024

Not stale, but might not be acted upon soon.

@hamlim hamlim removed the stale label Jun 30, 2024
Copy link

github-actions bot commented Sep 1, 2024

Automatically marking issue as stale due to lack of activity

@github-actions github-actions bot added the stale label Sep 1, 2024
Copy link

Automatically closing this issue as stale

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Sep 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation stale
Projects
None yet
Development

No branches or pull requests

1 participant