-
Notifications
You must be signed in to change notification settings - Fork 43
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
fix(ci): semantic-release workflow for v9 releases #1082
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kanadgupta
added a commit
that referenced
this pull request
Dec 4, 2024
this should ensure that we don't force push a major tag for our maintenance releases (e.g., a 9.x release when `main` is on 10.x)
here are the results of my li'l env variable test: ```json { "GITHUB_BASE_REF": "", "GITHUB_HEAD_REF": "", "GITHUB_REF": "refs/heads/next", "GITHUB_REF_NAME": "next", "GITHUB_REF_PROTECTED": "true", "GITHUB_REF_TYPE": "branch", "GITHUB_WORKFLOW_REF": "readmeio/rdme/.github/workflows/release.yml@refs/heads/next" } ``` see: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables#default-environment-variables
This was referenced Dec 5, 2024
Closed
Closed
Merged
kanadgupta
changed the title
feat(ci): semantic-release workflow for v9 releases
fix(ci): semantic-release workflow for v9 releases
Dec 11, 2024
mjcuva
approved these changes
Dec 12, 2024
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 super familiar with this package, but skimming the docs I think this seems good to me!
erunion
approved these changes
Dec 12, 2024
kanadgupta
pushed a commit
that referenced
this pull request
Dec 12, 2024
## [9.0.4-next.4](v9.0.4-next.3...v9.0.4-next.4) (2024-12-12) ### Bug Fixes * **ci:** semantic-release workflow for v9 releases ([#1082](#1082)) ([410daa7](410daa7)) [skip ci]
🎉 This PR is included in version 9.0.4-next.4 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
kanadgupta
pushed a commit
that referenced
this pull request
Dec 12, 2024
## [9.0.4](v9.0.3...v9.0.4) (2024-12-12) ### Bug Fixes * bring back [#1117](#1117) without breaking everything ([#1120](#1120)) ([d5d74c5](d5d74c5)) * **ci:** semantic-release workflow for v9 releases ([#1082](#1082)) ([410daa7](410daa7)) * copy package.json file instead of symlinking ([1d56c21](1d56c21)) * openapi arg doc enhancements, refactors ([#1122](#1122)) ([b83b233](b83b233)) [skip ci]
kanadgupta
added a commit
that referenced
this pull request
Dec 12, 2024
## 🧰 Changes this PR aggregates all of the PRs going out as part of the v10 release (i.e, the second section of PRs below). all PRs should be reviewed prior to being merged into this branch. ### outstanding tasks #### needs to go out _before_ v10 is released (i.e., in the v9 release channel) - [x] #1082 #### needs to go out as part of v10 release - [x] `openapi upload` - [x] #1111 - [x] #1116 - [x] #1107 - [x] #1104 - [x] #1108 #### merge into `v9` branch once `v10` release is successfully released - [ ] #1121 #### double-check these things before merging - [x] swap out any links to the `v9` docs (e.g., `/tree/v9`) with `v10` as needed (b19416d) - [x] make sure all API v1 requests in `v10` will work - [x] make sure v10 migration guide reflects the final design decisions around `openapi upload` ##⚠️ Breaking Changes <sub>listing all of the breaking changes 1 by 1 below so they get picked up by semantic release...</sub> BREAKING CHANGE: `categories`, `custompages`, `docs` and `versions` have now been removed. Please use a bidirectional syncing workflow instead. Read more in [our migration guide](https://github.com/readmeio/rdme/tree/v10/documentation/migration-guide.md). BREAKING CHANGE: `rdme openapi` has been replaced by `rdme openapi upload`. Read more in [our migration guide](https://github.com/readmeio/rdme/tree/v10/documentation/migration-guide.md).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🧰 Changes
sets up the
semantic-release
configuration so we can properly maintain v9 releases.further reading: https://semantic-release.gitbook.io/semantic-release/usage/workflow-configuration#maintenance-branches
outstanding work:
main
branch release (e.g., ifv10.0.1
is being published then the major tagging step should run, but if we're publishing av9.0.1
release then the major tagging step should not run)v9
branch is created and it's pointing to the same commit as thev9
tagv9
branch, then delete thev9
tag🧬 QA & Testing
we truly won't know if this works until it's merged 🫠 but that's why we have a
next
branch right?