Skip to content

Create release workflow - #4252

Open
clairep94 wants to merge 6 commits into
processing:developfrom
clairep94:clairep/add_createReleaseWorkflow
Open

Create release workflow#4252
clairep94 wants to merge 6 commits into
processing:developfrom
clairep94:clairep/add_createReleaseWorkflow

Conversation

@clairep94

Copy link
Copy Markdown
Collaborator

Issue:

  • Stops deploy-staging from triggering on unsuccessful unit test runs & only occur on successful ones
  • Update deploy to run after a Github release occurs (currently happens on merges to the release branch)
  • Adds release-reminder.yml which runs Tuesday 15:30 UTC -- generates Issue with the create-release workflow link
  • Adds release.yml which does two jobs: verify (CI testing) & release (creates the release draft, version, tags, etc). release waits on maintainer approval. If verify fails, the workflow run fails.

Demo:

Changes:

I have verified that this pull request:

  • has no linting errors (npm run lint)
  • has no test errors (npm run test)
  • has no typecheck errors (npm run typecheck)
  • is from a uniquely-named feature branch and is up to date with the develop branch.
  • is descriptively named and links to an issue number, i.e. Fixes #123
  • meets the standards outlined in the accessibility guidelines

@clairep94 clairep94 changed the title Create release workflor Create release workflow Aug 12, 2026
@clairep94

Copy link
Copy Markdown
Collaborator Author

cc: @doradocodes @raclim

@clairep94
clairep94 marked this pull request as ready for review August 12, 2026 10:48
Comment on lines +84 to +85
- name: Delete temporary release branch
run: git push origin --delete "release-${{ inputs.newversion }}"

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wondering if we should really delete after merging, in case we need the branch again later? @raclim what do you think?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think we should push the branch to retain a history of these?

If so, would it be useful to update this to "release-${{ inputs.newversion }}-auto" (or similar suffix) to track when we're merging releases from the workflow vs. manual?

1. `version` can be `major`, `minor`, `patch`, etc. (see [npm-version](https://docs.npmjs.com/cli/version) for valid values.
4. Wait for the workflow to run the `verify` job.
1. This tests the checkout code from `develop`.
2. If tests fail, the workflow will stop & record its result as a failure. Devs should fix any test failures, then attempt the [Create a release](../.github/workflows/release.yml) workflow again.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So if the tests fail, will the version get bumped twice?

@clairep94 clairep94 Aug 13, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No the release.yaml > verify job doesn't include steps for bumping, those are in the release.yaml > release job
The input for version is just captured and used later on the release.yaml > release job (if release.yaml > verify passes)

@doradocodes

Copy link
Copy Markdown
Collaborator

Thanks for working on this so quickly @clairep94 !

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