Skip to content

Conversation

@thompson-tomo
Copy link
Contributor

@thompson-tomo thompson-tomo commented Dec 6, 2025

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:

  • Set npm package version based on tag value
  • Create npm package
  • Uploads npm package to npm
  • Create github release with npm package attached and auto generated release notes

Required steps by maintainers to enable closure of the 2 issues:

image

followed by the create release notes option:
image
-> Needed for #197

@thompson-tomo thompson-tomo force-pushed the infra/#240_CreateRelease branch 6 times, most recently from 8de0aa1 to c1be012 Compare December 6, 2025 02:16
@thompson-tomo thompson-tomo changed the title Infra: #197/#240 create release using workflows infra: #197/#240 create release using workflows Dec 7, 2025
@thompson-tomo thompson-tomo force-pushed the infra/#240_CreateRelease branch from 7247e50 to 2935046 Compare December 8, 2025 01:42
@thompson-tomo
Copy link
Contributor Author

@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.

@thompson-tomo thompson-tomo force-pushed the infra/#240_CreateRelease branch 2 times, most recently from a0f8d6b to de1bab5 Compare December 26, 2025 01:23
@thompson-tomo thompson-tomo force-pushed the infra/#240_CreateRelease branch from de1bab5 to dc354bf Compare December 26, 2025 01:24
"name": "doctoc",
"description": "Generates TOC for markdown files of local git repo.",
"version": "2.2.0",
"version": "0.0.0-development",
Copy link
Collaborator

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.

Copy link
Contributor Author

@thompson-tomo thompson-tomo Dec 28, 2025

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.

Copy link
Contributor

Copilot AI left a 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.

Copy link
Contributor

Copilot AI left a 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants