Switch to Changesets-based release process by Andarist · Pull Request #118 · changesets/action

Andarist · 2021-11-22T09:04:32Z

The goal of this PR is to have a good release process in place. After this lands we should:

have a clear way to pin the action to a specific version
should no longer have guaranteed conflicts when parallel work is happening on branches (cause dist wont be committed now)
should increase the security (we were not reviewing dist before merging and a bad actor could tamper with this)

Andarist · 2021-11-22T09:05:20Z

.github/workflows/version-or-publish.yml

+on:
+  push:
+    branches:
+      - main


we should be able to rename the base branch now - we need to preserve master as artifact of the past though as all existing users are using that ref at the moment

Andarist · 2021-11-22T09:06:19Z

scripts/release.js

@@ -0,0 +1,35 @@
+const path = require("path");


I've done my best to test this before creating the PR - but as with any CI work... i could miss something and we'll have to supervise the first automated run of this script

Andarist · 2021-11-22T11:40:47Z

scripts/release.js

@@ -0,0 +1,35 @@
+const path = require("path");
+const { exec, getExecOutput } = require("@actions/exec");
+const tag = `v${require("../package.json").version}`;


There is also a question - what version should we release first? I probably would say that we should immediately bump to v1 - leaving a possibility to add all missing tags retroactively in the future

emmenko

Great idea, thanks for looking into this!

emmenko · 2021-11-23T19:31:22Z

.github/workflows/version-or-publish.yml

+      - name: Checkout Repo
+        uses: actions/checkout@master
+
+      - name: Setup Node.js 12.x


Shouldn't we use at least node 14?

I'm not sure if that has changed since then but apparently noode 14 couldn't be used a few months back:
actions/github-script#182 (comment)

Where is actions/github-script being used?

ah, i might have confused both things in a hurry - it might only not be possible to use node 14 for action itself but a workflow through setup-node action can actually use node 14

.github/workflows/version-or-publish.yml

emmenko · 2021-11-23T19:35:54Z

.github/workflows/version-or-publish.yml

+
+      - name: Install Dependencies
+        run: yarn
+


Add a step to build the code here?

build is happening within the release script - and it's only done after we check if we need to release at all, so this is a minor optimization of the execution run, since most of the runs wont need to release and thus wont have to run build

.github/workflows/version-or-publish.yml

emmenko · 2021-11-23T19:37:47Z

.github/workflows/version-or-publish.yml

+          version: yarn version
+          publish: yarn release


Can you explain why do we need those two custom built scripts? 🤔

version:

runs changeset version

and updates README

release:

checks if the current version has already been released

builds

commits

tags the commit

pushes the tag out

It's not a standard npm-based flow that is somewhat assumed by Changesets.

emmatown · 2021-11-23T23:12:39Z

Could we add a v${major} tag? (and maybe v${major}.${minor} but I don't care very much about that) I don't really see the value in setting changesets/action@v${major}.${minor}.${patch} since it's bad for both staying up to date and ensuring the code you're using can't be tampered with, if you want to ensure that the code can't be tampered with, you should be using a commit and if you want to stay up to date, you should use a v${major} or v${major}.${minor} tag.

Co-authored-by: Nicola Molinari <[email protected]>

Andarist · 2021-11-24T22:32:53Z

@mitchellhamilton Ok, makes sense - I've implemented the suggested change

Andarist · 2021-11-24T22:34:41Z

scripts/release.js

+  await exec("git", [
+    "push",
+    "--force",
+    "--follow-tags",
+    "origin",
+    `HEAD:refs/heads/${releaseLine}`,
+  ]);


note that i've chosen to use a branch for this because branches sync better than tags between remote and a local copy, to push out a tag with the same label we need to first destroy it and recreate. In general, I prefer to treat tags as immutable pointers.

emmatown · 2021-11-25T00:01:22Z

The code looks fine to me, I'm thinking we should merge this to a new main branch, do a release and when we've tested it, change the default branch to main so we can make sure it works without breaking existing users if the new thing is initially broken? After that, we might want to add to the action on master to make it log a warning (as in https://docs.github.com/en/actions/learn-github-actions/workflow-commands-for-github-actions#setting-a-warning-message) telling people to use the updated version.

Andarist · 2021-11-25T00:35:26Z

@mitchellhamilton do u want to do it or should i go with it when i wake up?

emmatown · 2021-11-25T00:50:34Z

Happy for you to do it

Co-authored-by: Nicola Molinari <[email protected]>

Andarist requested a review from emmatown November 22, 2021 09:04

Andarist commented Nov 22, 2021

View reviewed changes

Switch to Changesets-based release process

f4c3c74

Andarist force-pushed the use-changesets branch from 20c04cf to f4c3c74 Compare November 22, 2021 09:08

Andarist commented Nov 22, 2021

View reviewed changes

Andarist added 2 commits November 23, 2021 13:30

Bump version

b93fa6b

drop unused variable

5001ac4

emmenko reviewed Nov 23, 2021

View reviewed changes

Andarist and others added 2 commits November 24, 2021 21:48

Update .github/workflows/version-or-publish.yml

630a439

Co-authored-by: Nicola Molinari <[email protected]>

Push also to a release line branch when releasing

7b6b77d

Andarist commented Nov 24, 2021

View reviewed changes

emmatown approved these changes Nov 25, 2021

View reviewed changes

Andarist changed the base branch from master to main November 25, 2021 16:24

Andarist and others added 4 commits November 25, 2021 17:27

Change node version used in the version-or-publish workflow

71d09c8

Switch to using the local action

57095d2

Co-authored-by: Nicola Molinari <[email protected]>

build the action before trying to use it the workflow

f65e7a0

Add changeset and actually setup Changesets, lol

d7e168a

Andarist merged commit 05c863d into main Nov 25, 2021

Andarist deleted the use-changesets branch November 25, 2021 16:51

github-actions bot mentioned this pull request Nov 25, 2021

Version Packages #119

Merged

mondash mentioned this pull request Dec 7, 2021

Tags corresponding to semver. #86

Closed

github-actions bot mentioned this pull request Sep 8, 2022

Version Packages pedronauck/changesets-action#1

Closed

This comment was marked as spam.

Sign in to view

Conversation

Andarist commented Nov 22, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

emmenko left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Andarist Nov 25, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

emmatown commented Nov 23, 2021

Uh oh!

Andarist commented Nov 24, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

emmatown commented Nov 25, 2021

Uh oh!

Andarist commented Nov 25, 2021

Uh oh!

emmatown commented Nov 25, 2021

Uh oh!

This comment was marked as spam.

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Andarist Nov 25, 2021 •

edited

Loading