ci: "create-update-issues" workflow skips pre-1.0 breaking changes
- Dominant language
- TypeScript
- Stars
- 413
- Forks
- 308
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 253
Description
The `create-update-issues` workflow is intended to create issues in extension and mobile for updating controllers after a breaking change. However, it currently only looks for major version bumps. Breaking changes to controllers that are pre-1.0 are not considered.
We should update the workflow to create issues for breaking changes in pre-1.0 controllers as well. i.e. when the major version is zero, a minor bump should be considered breaking and trigger the creation of issues.
Note that technically according to SemVer, any pre-1.0 release can be breaking, even patch releases. But it's conventional for many package authors (and on our team) that pre-1.0 breaking changes be released as a minor version bump (and this is how the `^` operator works, [see here for more details](https://github.com/npm/node-semver?tab=readme-ov-file#caret-ranges-123-025-004)), so that's what this workflow will assume.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the `create-update-issues` workflow and trace the version-bump check that currently only recognizes major releases. Verify the expected behavior when the major version is zero, using the SemVer and caret-range guidance in the issue. Done means pre-1.0 minor breaking changes trigger issue creation while the existing major-version behavior remains intact.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100