So I see the (semi-)automated release flow going like so:

Create new workflow (prepare-release) that:
- triggers only on main with changes in ['def/*', 'include/*']
- updates package version via npm version minor
- updates CHANGELOG.md with the notable changes and commits list since last release tag
- creates branch release/v<version>
- commits changes with commit message release: v<version>
- creates PR with title release: v<version> and body Automated release for version v<version>
Create new workflow (publish-release) that:
- triggers only on main with changes in package.json
- runs only if package version is not published on npm
- runs npm publish
- creates and pushes tag v<version>
- creates a GitHub Release for new tag with "Whats Changed" as a list of all commits since tag of last published version

I would not want a 100% automatic publishing process, and so this above CI flow would require only one manual step for the release: approving the PR with the version change created by prepare-release. This gives us a chance to make any changes as needed (eg. updating READMEs, adding contributors, ...) before the final publish. Also due to branch protection, we can't write directly into main, which is why some PR must exist.

I am also tempted to not have the publish-release workflow be automatic, and require running the action manually.

Thoughts on all of this?

Uh oh!

Investigate automation of publishing new npm versions #13

Description

Metadata

Metadata

Assignees

Labels

Type

Fields

Projects

Milestone

Relationships

Development

Issue actions