feat: Adding Release Automation #1122

whizzzkid · 2022-12-20T09:46:02Z

Relates to: #778

In this PR (Solves part 1 of #778):

Once a PR is merged, a release PR is now automatically created.
This release PR stays collecting new versions till we are ready to merge.
On release PR merge, a new tag gets released.
On a new tag push, we then create a draft release with:
- New version tag.
- Release Notes.
- Assets downloaded from the previous step.

QoL improvements:

The assets are now built and added to the draft release, the releaser only needs to download these assets and upload to respective web-stores.
Future step would be to sign these assets and upload as part of CI.

whizzzkid

explainers

whizzzkid · 2022-12-20T09:49:46Z

.github/workflows/ci.yml

+  release-pr:
+    runs-on: ubuntu-latest
+    needs: [test]
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'


this only needs to run on push after the tests have succeeded. Creates a release-pr based on conventional-commits commit strategy (which we already follow)

This defines what a release PR is: https://github.com/google-github-actions/release-please-action#whats-a-release-pr

whizzzkid · 2022-12-20T09:51:13Z

.github/workflows/ci.yml

+          release-type: node
+          package-name: ipfs-companion
+          changelog-notes-type: github
+          command: release-pr


auto-increments the computed semver

names the package

creates changelog

only creates the release PR

This PR can stay around for as long as it's needed, as soon as that gets merged it pushes the release tags.

whizzzkid · 2022-12-20T09:57:35Z

.github/workflows/ci.yml

+      - uses: actions/download-artifact@v3
+        id: download
+        with:
+          name: built-on-ubuntu-latest
+          path: ~/downloads/


we publish artifacts as part of the release process, we don't need to build those again (I am not sure if the download path is reachable) This from one of their examples https://github.com/actions/download-artifact/tree/main#download-path-output

The artifacts uploaded look like this: https://github.com/ipfs/ipfs-companion/actions/runs/3727290259#artifacts

The uploaded artifacts are developer version, we can't use them for release:

ipfs_companion_dev_build_bf88bee_-2.20.1.1059_brave.zip ipfs_companion_dev_build_bf88bee_-2.20.1.1059_chromium.zip ipfs_companion_dev_build_bf88bee_-2.20.1.1059_firefox.zip

To build a release artifacts,
you need to run build in the docker with env variable RELEASE_CHANNEL set to stable.

We have convenience script npm run release-build that does reproducible build in Docker and sets proper version and name in manifest.

I see two ways of fixing this.
You want to special-case build happening on tag (if: github.event_name == 'push' && contains(github.ref, 'refs/tags/') and then either:

(A) Keep deterministic release build based on Docker and run npm run release-build instead of npm run ci:build

(B) Remove Docker, and set RELEASE_CHANNEL=stable so when npm run ci:build is called it will produce release artifacts, and not dev ones.

I think we could remove Docker and do (B) only if you confirm that the build produces exactly the same artifact on windows/linux/macos. Otherwise we risk rjection by Mozilla's Add-On Store.

whizzzkid · 2022-12-20T09:58:32Z

.github/workflows/ci.yml

+          files: ${{ steps.download.outputs.download-path }}/*.zip
+          fail_on_unmatched_files: true
+          generate_release_notes: true
+          draft: true
+          append_body: true
+          body: 'Automated Release, please upload artifacts to respective webstores and mark this draft as released.'


Once we have the assets we can now create a draft release, with release notes + fail if the files are not found.

SgtPooki

this all looks legit to me and looks like a significant improvement

lidel

This is a very nice quality of life improvement! Thank you @whizzzkid ❤️

Before we merge, mind addressing two issues below?

lidel · 2023-01-11T17:48:24Z

.github/workflows/ci.yml

+      - uses: actions/download-artifact@v3
+        id: download
+        with:
+          name: built-on-ubuntu-latest
+          path: ~/downloads/


The uploaded artifacts are developer version, we can't use them for release:

ipfs_companion_dev_build_bf88bee_-2.20.1.1059_brave.zip ipfs_companion_dev_build_bf88bee_-2.20.1.1059_chromium.zip ipfs_companion_dev_build_bf88bee_-2.20.1.1059_firefox.zip

To build a release artifacts,
you need to run build in the docker with env variable RELEASE_CHANNEL set to stable.

We have convenience script npm run release-build that does reproducible build in Docker and sets proper version and name in manifest.

I see two ways of fixing this.
You want to special-case build happening on tag (if: github.event_name == 'push' && contains(github.ref, 'refs/tags/') and then either:

(A) Keep deterministic release build based on Docker and run npm run release-build instead of npm run ci:build

(B) Remove Docker, and set RELEASE_CHANNEL=stable so when npm run ci:build is called it will produce release artifacts, and not dev ones.

I think we could remove Docker and do (B) only if you confirm that the build produces exactly the same artifact on windows/linux/macos. Otherwise we risk rjection by Mozilla's Add-On Store.

lidel · 2023-01-11T17:52:57Z

.github/workflows/ci.yml

+      - name: Release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: ${{ steps.download.outputs.download-path }}/*.zip
+          fail_on_unmatched_files: true
+          generate_release_notes: true
+          draft: true
+          append_body: true


built-on-ubuntu-latest.zipis nice, but having to unpack it every time to get firefox or chrome specific version and then re-upload it to release is a bit tedious.

Mind adding a step that unzips it, so CI attach three ipfs_companion*.zip to the release, and person making the release does not need to unzip anything?

whizzzkid

Ready for re-review @lidel

package.json

.github/workflows/ci.yml

whizzzkid · 2023-01-23T18:08:54Z

@lidel one of the test seems to be taking longer than usual, fix here: #1136

Once that's merged this PR should pass.

SgtPooki

approving the updates, but a note that I only saw the fix for the release-build comment lidel had. I didn't catch the three separate zips issue he was talking about so leaving that to @lidel to confirm

SgtPooki · 2023-01-24T18:18:41Z

.github/workflows/ci.yml

@@ -110,18 +110,42 @@ jobs:
    needs: [test]
    if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
    steps:
-      - uses: actions/checkout@v2
+      - name: Check out Git repository
+        uses: actions/checkout@v1


why downgrading to checkout@v1?

Other actions from the actions namespace also seem to be outdated. I'd recommend updating them all.

I don't recall what I was thinking, now everything should be updated to latest. The only problem here would be that it's not easy to test github actions locally. I did manually verify that the api we require is not broken between versions. 🤞🏽

SgtPooki · 2023-01-24T18:20:02Z

.github/workflows/ci.yml

+      - name: Restore node_modules
+        id: yarn-cache
+        uses: actions/cache@v2
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-${{ hashFiles('**/package-lock.json') }}


just FYI: aegir actually has a great github action that allows us to cache node-modules. we should be using that most places to ensure we're consistent.

https://github.com/ipfs/aegir/blob/master/actions/cache-node-modules/action.yml#L27-L36

that action seems to cache dist too. In this case we don't need that, it will create a conflict as we build stable version later, we don't want that to be cached. We just need node_modules.

lidel

@whizzzkid thank you!

Small concern around softprops/action-gh-release described below, but if you switch to specific revision, it is ok to merge.

lidel · 2023-01-31T22:20:16Z

.github/workflows/ci.yml

+        run: npm run ci:build:stable
+
+      - name: Release
+        uses: softprops/action-gh-release@v1


⚠️ @whizzzkid any reason why we are not reusing google-github-actions/release-please-action here with command set to github-release?

Not a blocker, but softprops/action-gh-release being a personal account of an individual has a higher risk of being compromised, and that could inject code that would ship to our users.

If we have to use it, please pin it to a specific revision before merging this PR:

Suggested change

uses: softprops/action-gh-release@v1

uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844

For future reference, remember to add to the safelist at https://github.com/ipfs/ipfs-companion/settings/actions:

Thanks for the callout on adding specific version and whitelisting this.

Not a blocker, but softprops/action-gh-release being a personal account of an individual has a higher risk of being compromised, and that could inject code that would ship to our users.

google-github-actions/release-please-action doesn't seem to have documentation on creating a draft release. It just pushes the release (that's what i tested on other repo).

Looks like https://github.com/google-github-actions/release-please-action/pull/398/files seems to suggest there is draft: boolean but it does not support uploading files, which we want, I'll try creating documentation for them.

Adding release automation step

abecc22

whizzzkid requested review from lidel, meandavejustice and a team as code owners December 20, 2022 09:46

whizzzkid added 3 commits December 20, 2022 02:47

blocking step

c392dd9

unneeded check

123ef85

path renaming

8648ba1

whizzzkid commented Dec 20, 2022

View reviewed changes

whizzzkid requested a review from SgtPooki December 20, 2022 09:58

Merge branch 'main' into feat/release-automation

7fcb39d

SgtPooki approved these changes Jan 11, 2023

View reviewed changes

lidel requested changes Jan 11, 2023

View reviewed changes

whizzzkid added 3 commits January 22, 2023 19:22

Merge branch 'main' into feat/release-automation

55fc56c

feat: ♻️ Refactor ci:build:stable

5845bc4

feat: 📦 Create Release Asset for Stable Env

b06eb91

whizzzkid commented Jan 23, 2023

View reviewed changes

package.json Show resolved Hide resolved

.github/workflows/ci.yml Show resolved Hide resolved

.github/workflows/ci.yml Show resolved Hide resolved

whizzzkid requested a review from lidel January 23, 2023 09:38

SgtPooki approved these changes Jan 24, 2023

View reviewed changes

whizzzkid and others added 3 commits January 24, 2023 15:53

Merge branch 'main' into feat/release-automation

cc82db8

Merge branch 'main' into feat/release-automation

e91de0c

Merge branch 'main' into feat/release-automation

a9305bb

lidel approved these changes Jan 31, 2023

View reviewed changes

feat: 📌 Pinning github-actions versions

d7a3bea

whizzzkid merged commit 1ed411e into main Feb 2, 2023

whizzzkid deleted the feat/release-automation branch February 2, 2023 04:35

This was referenced Feb 8, 2023

chore(fix/release-please): release ipfs-companion 2.22.0 #1150

Closed

chore(fix/release-please): release ipfs-companion 2.22.0 [demo-only-don't-merge] #1151

Closed

This was referenced Feb 15, 2023

chore(main): release ipfs-companion 2.22.0 #1157

Merged

chore(main): release ipfs-companion 2.23.0 #1159

Closed

github-actions bot mentioned this pull request Sep 21, 2023

chore(main): release 3.0.1 #1288

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Adding Release Automation #1122

feat: Adding Release Automation #1122

whizzzkid commented Dec 20, 2022

whizzzkid left a comment

whizzzkid Dec 20, 2022

whizzzkid Dec 20, 2022

whizzzkid Dec 20, 2022

lidel Jan 11, 2023 •

edited

Loading

whizzzkid Dec 20, 2022

SgtPooki left a comment

lidel left a comment •

edited

Loading

lidel Jan 11, 2023 •

edited

Loading

lidel Jan 11, 2023

whizzzkid left a comment

whizzzkid commented Jan 23, 2023

SgtPooki left a comment

SgtPooki Jan 24, 2023

galargh Feb 1, 2023

whizzzkid Feb 2, 2023

SgtPooki Jan 24, 2023

whizzzkid Feb 2, 2023

lidel left a comment

lidel Jan 31, 2023

whizzzkid Feb 2, 2023

whizzzkid Feb 2, 2023

	uses: softprops/action-gh-release@v1
	uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844

feat: Adding Release Automation #1122

feat: Adding Release Automation #1122

Conversation

whizzzkid commented Dec 20, 2022

whizzzkid left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lidel Jan 11, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SgtPooki left a comment

Choose a reason for hiding this comment

lidel left a comment • edited Loading

Choose a reason for hiding this comment

lidel Jan 11, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

whizzzkid left a comment

Choose a reason for hiding this comment

whizzzkid commented Jan 23, 2023

SgtPooki left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lidel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lidel Jan 11, 2023 •

edited

Loading

lidel left a comment •

edited

Loading

lidel Jan 11, 2023 •

edited

Loading