-
-
Notifications
You must be signed in to change notification settings - Fork 491
infra: #197/#240 create release using workflows #289
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
base: master
Are you sure you want to change the base?
infra: #197/#240 create release using workflows #289
Conversation
8de0aa1 to
c1be012
Compare
7247e50 to
2935046
Compare
|
@PeterDaveHello / @AndrewSouthpaw / @thlorenz thoughts on automating the release process including release note generation? Note the manual steps to generate old release notes described in description. |
a0f8d6b to
de1bab5
Compare
de1bab5 to
dc354bf
Compare
| "name": "doctoc", | ||
| "description": "Generates TOC for markdown files of local git repo.", | ||
| "version": "2.2.0", | ||
| "version": "0.0.0-development", |
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.
I'm not sure if this is a good idea, as based on my limited experience with Node.js app development, it doesn't appear to be a common practice.
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.
For me it is better and more efficient to use a clear placeholder value rather than having to either manually maintain the version value or adding more advanced ci pipelines given low volume of releases. Note this value is used purely for informational purposes as the git tag value is used to ensure they are aligned.
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.
Pull request overview
This PR introduces automated release management through GitHub workflows to prevent manual release inconsistencies. The workflow triggers on version tags and automates npm package publishing and GitHub release creation.
Key changes:
- Sets package.json version to development placeholder to be updated by workflow
- Adds GitHub workflow that publishes to npm and creates releases on tag push
- Requires maintainer setup of npm trusted publishers and retroactive release creation
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| package.json | Version changed to development placeholder for workflow automation |
| .github/workflows/release.yml | New workflow automating npm publish and GitHub release on version tags |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
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.
Pull request overview
Copilot reviewed 2 out of 3 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
Avoids #197 and #240 being an issue going forward and resolves if maintainer steps below are done.
This introduces github workflow for managing releases. This workflow is triggered when a tag is added to a commit and performs the following:
Required steps by maintainers to enable closure of the 2 issues:
followed by the create release notes option:

-> Needed for #197