Skip to content
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 14 commits into from
Dec 12, 2024

Conversation

kanadgupta
Copy link
Member

@kanadgupta kanadgupta commented Nov 22, 2024

🧰 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:

  • make sure that the major tag is only set on the main branch release (e.g., if v10.0.1 is being published then the major tagging step should run, but if we're publishing a v9.0.1 release then the major tagging step should not run)
  • (do this right before merging) make sure a v9 branch is created and it's pointing to the same commit as the v9 tag
  • (do this right after merging) if the release was successfully published to the v9 branch, then delete the v9 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?

@kanadgupta kanadgupta added this to the v10 milestone Nov 22, 2024
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
@kanadgupta kanadgupta changed the title feat(ci): semantic-release workflow for v9 releases fix(ci): semantic-release workflow for v9 releases Dec 11, 2024
@kanadgupta kanadgupta marked this pull request as ready for review December 11, 2024 23:57
@kanadgupta kanadgupta requested review from erunion and mjcuva December 11, 2024 23:57
Copy link
Member

@mjcuva mjcuva left a 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!

@kanadgupta kanadgupta merged commit 410daa7 into next Dec 12, 2024
10 checks passed
@kanadgupta kanadgupta deleted the kanad-2024-11-21/v9-release-branch branch December 12, 2024 23:13
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]
@kanadgupta
Copy link
Member Author

🎉 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants