build: semantic release #746

kanadgupta · 2023-02-10T19:59:31Z

🧰 Changes

This PR brings semantic-release into the mix so we can have a proper pre-release tagging/release process for some of the upcoming Docker build stuff we're doing.

Here's an overview of the changes:

Changes our default branch in this repository from main to next (already done)
Set up husky commit linting to make sure all commits conform to angular commit conventions
Sets up a prelease process tied to the next branch and a proper release process tied to the next branch
Set up a semantic-release plugin setup that publishes releases to GitHub and npm (see MAINTAINERS.md in this PR for more information)

Outstanding Tasks

Make sure major version tagging script in bin/set-major-version-tag.js tags the right commit
See if we can get rid of the duplicative tag thing (i.e. v8.0 vs 8.0) (update: ~~removed it for now, I think it should be fine?~~ got it working again)
See if GitHub release text can be easily formatted (update: ~~got something better going but it's not super pretty~~ gonna create draft releases with gh instead)
(Maybe further down the line) see if we can add a semantic-release plugin for publishing to GitHub's container registry (edit: this should actually work)
Make sure release flow has permissions to commit to protected branch (edit I think this is working, but we won't know until it's in next 😬)
~~See if I need to generate a GitHub token with more permissions in order to trigger a released event (further reading)~~ (edit: don't think I actually need this)
Update MAINTAINERS.md with the new guidance
Make sure I revert all the temporary configuration specific to the semantic-release branch
Figure out how the whole process of merging main back into next will work (we won't know until all of this is live 😬)

🧬 QA & Testing

I ran a bunch of test workflows against this branch. Here are a few artifacts for 8.6.0-next.8 to confirm this is working as expected¹:

The draft GitHub release: https://github.com/readmeio/rdme/releases/tag/untagged-65b3ca5703669a87a0af
The updated CHANGELOG.md
The build commit created by semantic-release: 05af285
The two git tags: 8.6.0-next.8 and v8.6.0-next.8
The updated version field in the package.json
The npm release (which is properly published to the next channel): https://www.npmjs.com/package/rdme/v/8.6.0-next.8

The main files that actually necessitate your review are .releaserc.yml and MAINTAINERS.md 🥺

(and let me know if I missed anything! lots of moving parts 😮‍💨) ↩

apparently semantic-release likes this better I don't know

technically a chore but making it a feat to see what semantic-release does with it

# [8.6.0-next.2](v8.6.0-next.1...v8.6.0-next.2) (2023-02-10) ### Features * add git + changelog plugins ([85e4bfd](85e4bfd)) [skip ci]

## What's Changed in 8.6.0-next.3 ### Bug Fixes * rebuild prior to npm publish ([29b9ec6](29b9ec6)) * reformat github release header ([38c5625](38c5625)) [skip ci]

## What's Changed ### Bug Fixes * reformat header again ([bd2e1a2](bd2e1a2)) ### Features * drop duplicative tag ([4c34207](4c34207)) [skip ci]

This reverts commit 4c34207.

hopefully this will put the extra tag on the correct commit?

## What's Changed ### Bug Fixes * try rearranging steps like this ([cac0c1d](cac0c1d)) ### Reverts * Revert "feat: drop duplicative tag" ([f9fe6c6](f9fe6c6)) [skip ci]

This reverts commit 05300e7.

github actions don't appear to run for the merge commit and I don't know why so I'm just gonna have it skip CI entirely in a cleaner platform-native way https://github.blog/changelog/2021-02-08-github-actions-skip-pull-request-and-push-workflows-with-skip-ci/

kanadgupta · 2023-02-13T22:47:07Z

.releaserc.yml

+  # in the `postversion` npm hook
+  - '@semantic-release/npm'
+  # Lightweight alternative to `@semantic-release/github` that creates a draft release
+  - ['@semantic-release/exec', { 'publishCmd': 'gh release create ${nextRelease.version} --draft --generate-notes' }]


TIL that the GitHub CLI is pre-installed on GitHub Actions runners: https://docs.github.com/en/actions/using-workflows/using-github-cli-in-workflows

kanadgupta · 2023-02-13T22:47:39Z

package.json

@@ -29,7 +29,7 @@
  ],
  "repository": {
    "type": "git",
-    "url": "git://github.com/readmeio/rdme.git"
+    "url": "https://github.com/readmeio/rdme.git"


I guess semantic-release actually uses this field and likes this better 🤷🏽‍♂️

kanadgupta · 2023-02-13T23:14:46Z

CHANGELOG.md

@@ -1,3 +1,66 @@
+# [8.6.0-next.7](https://github.com/readmeio/rdme/compare/v8.6.0-next.6...v8.6.0-next.7) (2023-02-13)


there are a few formatting discrepancies in this file now but I really care to be honest

kanadgupta · 2023-02-13T23:36:30Z

.releaserc.yml

+        # since we're also updating the action.yml file with every release!
+        # Uncomment this line below once those changes are live:
+        # assets: ['action.yml', 'CHANGELOG.md', 'package.json', 'package-lock.json'],
+        message: "build(release): 🚀 v${nextRelease.version} 🦉\n\n${nextRelease.notes}\n[skip ci]",


[skip ci] is a special phrase, see https://github.blog/changelog/2021-02-08-github-actions-skip-pull-request-and-push-workflows-with-skip-ci/

erunion

nice

RyanGWU82 · 2023-02-13T23:46:18Z

A couple of general questions:

What's the value of having a prerelease process on the next branch?
~~Have we confirmed that the code pushes from semantic-release don't themselves trigger new runs of semantic-release? (Let's make sure this won't cause an infinite loop 😭)~~ (oops, forgot about [skip ci])
Have you confirmed this actually works as a GitHub Action? We weren't able to get that working on readme because GitHub doesn't allow code pushes from inside GitHub Actions, even if the GITHUB_TOKEN would otherwise have access privileges to do this. If it does work, do you know how/why it works since it didn't on readme? (Could we apply the same "fix" to readme? 🤔)

RyanGWU82

Great documentation! 🙇🏼

kanadgupta · 2023-02-13T23:54:27Z

What's the value of having a prerelease process on the next branch?

A couple of reasons!

We can actually do a global install (i.e., npm i -g rdme) locally and play around with prerelease version in a variety of different directories to confirm that changes work as expected (this is something I've wanted for a while)
Since we're going to publish every Docker build to the GitHub container registry (inspired by this repo), we need an end-to-end technique to test out the GitHub Action before tagging official releases... in other words, we need to use a tagged Docker container release to properly test GitHub Actions 😬 not ideal but the pros should hopefully outweigh the cons 🤞🏽

Have you confirmed this actually works as a GitHub Action? We weren't able to get that working on readme because GitHub doesn't allow code pushes from inside GitHub Actions, even if the GITHUB_TOKEN would otherwise have access privileges to do this. If it does work, do you know how/why it works since it didn't on readme? (Could we apply the same "fix" to readme? 🤔)

Yeah I remember those issues... will report back once this workflow actually runs in next and main, but I've tried basically everything I can think of on this branch (protecting this branch, actually tagging releases, etc.) and the GITHUB_TOKEN appears to be working fine? Maybe GitHub has since made some fixes to their Actions permissioning so we can finally do this now 🧐

@RyanGWU82

RyanGWU82 · 2023-02-14T00:21:46Z

Thanks @kanadgupta. The issue with GHA permissions was that you couldn't use GHA to actually make commits on a git branch. You could interact with the API as much as you wanted (for tagging, replying to issues, etc) but you couldn't actually save the commit to update the version number or the changelog. Were you able to test it on a branch and have it actually make a commit on that branch?

It's been over a year since I looked at that, so maybe they got it working in a newer version of semantic-release?

kanadgupta · 2023-02-14T02:36:48Z

@RyanGWU82 yeah there are a few examples on this branch if you want to look, like this one: 05af285

I also tried adding protections to this branch and it still appeared to work 🧐

* chore: initial commit * chore: how about this? * chore: what about this * fix: try this instead * chore: see if warnings are surfaced properly * Revert "chore: see if warnings are surfaced properly" This reverts commit edaf715. * revert: restore simple.yml * chore: update dockerfile path * build: semantic release (#746) * chore: shorten docker path * perf: try using alpine

# [8.6.0-next.10](v8.6.0-next.9...v8.6.0-next.10) (2023-02-15) ### Features * docker (again) ([#763](#763)) ([2144572](2144572)), closes [#746](#746) [skip ci]

# [8.6.0](v8.5.0...v8.6.0) (2023-03-29) ### Bug Fixes * bad merge ([e15c574](e15c574)) * bump node version in release workflow ([7f3158f](7f3158f)) * does this work? ([c81e432](c81e432)) * memory leak in large file handling within openapi-parser ([#784](#784)) ([1b1cc00](1b1cc00)) * next channel ([ce4e494](ce4e494)) * **openapi:** yaml strings would be improperly parsed as Date objects ([#779](#779)) ([72e75cb](72e75cb)) * rebuild prior to npm publish ([29b9ec6](29b9ec6)) * reformat github release header ([38c5625](38c5625)) * reformat header again ([bd2e1a2](bd2e1a2)) * remove some of the package scripts ([3eb52fd](3eb52fd)) * remove unnecessary config ([c22889c](c22889c)) * run tests but NOT release workflow on release commits ([24f885e](24f885e)) * temporarily disable release workflow ([a935268](a935268)) * try rearranging steps like this ([cac0c1d](cac0c1d)) * try this approach to lifecycle events ([4e5ecff](4e5ecff)) * try this as an alternative to @semantic-release/github ([8c343a0](8c343a0)) * try this to see if branch protections work ([f314c3f](f314c3f)) * turns out these rules weren't redundant ([f9f82f1](f9f82f1)) * upgrading `oas-normalize` to move to our `postman-to-openapi` fork ([#776](#776)) ([ee8ce0a](ee8ce0a)) ### Features * add git + changelog plugins ([85e4bfd](85e4bfd)) * container registry ([#777](#777)) ([d193416](d193416)), closes [/github.com//pull/777#discussion_r1145516673](https://github.com//github.com/readmeio/rdme/pull/777/issues/discussion_r1145516673) [/github.com//pull/777#discussion_r1145528308](https://github.com//github.com/readmeio/rdme/pull/777/issues/discussion_r1145528308) * docker (again) ([#763](#763)) ([2144572](2144572)), closes [#746](#746) * empty commit to trigger release ([3e3c112](3e3c112)) * fix comment ([076cfbf](076cfbf)) ### Performance Improvements * **docker:** build executable ([#764](#764)) ([af2dbce](af2dbce)) ### Reverts * Revert "feat: drop duplicative tag" ([f9fe6c6](f9fe6c6)) * bring workflow name back ([c07495a](c07495a)) * don't set header for changelog ([194489e](194489e)) * restore release workflow ([9f6bbc9](9f6bbc9)) * ugh here we go again ([0b1e429](0b1e429)) [skip ci]

kanadgupta and others added 30 commits February 10, 2023 13:43

chore: fix repo url field

87f854f

apparently semantic-release likes this better I don't know

chore(deps-dev): install semantic-release, initial config

266787d

chore(deps-dev): add husky + commitlint

73fce60

Merge branch 'main' into semantic-release

c8d995d

ci: add release.yml

100f7fc

feat: fix comment

076cfbf

technically a chore but making it a feat to see what semantic-release does with it

chore: temporarily disable dryrun :meow-sweat:

5870124

fix: next channel

ce4e494

fix: remove some of the package scripts

3eb52fd

chore: restore dry runs

d8a722f

feat: add git + changelog plugins

85e4bfd

chore(temp): disable dry-run

baa1705

build(release): 🚀 v8.6.0-next.2 release 🦉

11799e1

# [8.6.0-next.2](v8.6.0-next.1...v8.6.0-next.2) (2023-02-10) ### Features * add git + changelog plugins ([85e4bfd](85e4bfd)) [skip ci]

chore: little bits of cleanup

1ba8bdd

fix: rebuild prior to npm publish

29b9ec6

fix: reformat github release header

38c5625

build(release): 🚀 v8.6.0-next.3 🦉

836a9f2

## What's Changed in 8.6.0-next.3 ### Bug Fixes * rebuild prior to npm publish ([29b9ec6](29b9ec6)) * reformat github release header ([38c5625](38c5625)) [skip ci]

fix: reformat header again

bd2e1a2

feat: drop duplicative tag

4c34207

build(release): 🚀 v8.6.0-next.4 🦉

523310f

## What's Changed ### Bug Fixes * reformat header again ([bd2e1a2](bd2e1a2)) ### Features * drop duplicative tag ([4c34207](4c34207)) [skip ci]

chore: remove github release npm script

05300e7

Revert "feat: drop duplicative tag"

f9fe6c6

This reverts commit 4c34207.

fix: try rearranging steps like this

cac0c1d

hopefully this will put the extra tag on the correct commit?

build(release): 🚀 v8.6.0-next.5 🦉

f0b241c

## What's Changed ### Bug Fixes * try rearranging steps like this ([cac0c1d](cac0c1d)) ### Reverts * Revert "feat: drop duplicative tag" ([f9fe6c6](f9fe6c6)) [skip ci]

revert: don't set header for changelog

194489e

chore: add comment

8463946

Revert "chore: remove github release npm script"

e77b67a

This reverts commit 05300e7.

chore(deps-dev): install @semantic-release/exec

1825c27

fix: run tests but NOT release workflow on release commits

24f885e

chore: add another comment

bb91531

kanadgupta added 4 commits February 13, 2023 18:23

revert: bring workflow name back

c07495a

chore: ok stop this now

eec7a2e

fix: remove unnecessary config

c22889c

kanadgupta commented Feb 13, 2023

View reviewed changes

kanadgupta marked this pull request as ready for review February 13, 2023 23:37

kanadgupta requested review from erunion, kellyjosephprice, rafegoldberg and RyanGWU82 February 13, 2023 23:37

Merge branch 'next' into semantic-release

c9a2910

kanadgupta added enhancement New feature or request refactor Issues about tackling technical debt labels Feb 13, 2023

erunion approved these changes Feb 13, 2023

View reviewed changes

RyanGWU82 approved these changes Feb 13, 2023

View reviewed changes

kanadgupta added 3 commits February 14, 2023 16:03

Merge branch 'next' into semantic-release

b04a8ce

Merge branch 'next' into semantic-release

1629acb

fix: bad merge

e15c574

kanadgupta mentioned this pull request Feb 15, 2023

feat: docker #759

Merged

kanadgupta merged commit 621b966 into next Feb 15, 2023

kanadgupta deleted the semantic-release branch February 15, 2023 15:28

kanadgupta restored the semantic-release branch February 15, 2023 17:03

kanadgupta deleted the semantic-release branch February 15, 2023 18:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

build: semantic release #746

build: semantic release #746

kanadgupta commented Feb 10, 2023 •

edited

Loading

kanadgupta Feb 13, 2023 •

edited

Loading

kanadgupta Feb 13, 2023

kanadgupta Feb 13, 2023

kanadgupta Feb 13, 2023

erunion left a comment

RyanGWU82 commented Feb 13, 2023 •

edited

Loading

RyanGWU82 left a comment

kanadgupta commented Feb 13, 2023

RyanGWU82 commented Feb 14, 2023

kanadgupta commented Feb 14, 2023 •

edited

Loading

		@@ -1,3 +1,66 @@
		# [8.6.0-next.7](https://github.com/readmeio/rdme/compare/v8.6.0-next.6...v8.6.0-next.7) (2023-02-13)

build: semantic release #746

build: semantic release #746

Conversation

kanadgupta commented Feb 10, 2023 • edited Loading

🧰 Changes

🧬 QA & Testing

Footnotes

kanadgupta Feb 13, 2023 • edited Loading

Choose a reason for hiding this comment

kanadgupta Feb 13, 2023

Choose a reason for hiding this comment

kanadgupta Feb 13, 2023

Choose a reason for hiding this comment

kanadgupta Feb 13, 2023

Choose a reason for hiding this comment

erunion left a comment

Choose a reason for hiding this comment

RyanGWU82 commented Feb 13, 2023 • edited Loading

RyanGWU82 left a comment

Choose a reason for hiding this comment

kanadgupta commented Feb 13, 2023

RyanGWU82 commented Feb 14, 2023

kanadgupta commented Feb 14, 2023 • edited Loading

kanadgupta commented Feb 10, 2023 •

edited

Loading

kanadgupta Feb 13, 2023 •

edited

Loading

RyanGWU82 commented Feb 13, 2023 •

edited

Loading

kanadgupta commented Feb 14, 2023 •

edited

Loading