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.

Sign up for GitHub

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

Jump to bottom

chore: workflow dispatch releases #161

Merged
merged 6 commits into from
Jul 31, 2024
Merged

chore: workflow dispatch releases #161

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
436eab7
init
Aslemammad Jul 26, 2024
8588856
update
Aslemammad Jul 26, 2024
a8fb833
update
Aslemammad Jul 26, 2024
a1089be
update
Aslemammad Jul 26, 2024
0a0b63c
use tags
Aslemammad Jul 27, 2024
d1b7905
add @vitejs/release-scripts
Aslemammad Jul 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 42 additions & 3 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,24 @@ on:
push:
branches:
- main
- release
pull_request:
workflow_dispatch:
inputs:
version:
description: "type of ref"
required: true
type: choice
options:
- patch
- minor
- major
default: "patch"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of doing this with a workflow dispatch, I think it is better to do a scheme like we have in Vite. We have a release script that bumps the version in main and commits that (together with the changelog but not needed here if you don't want) and tags that commit with vX.Y.Z. And then we have an github workflow that publishes each tag that matches that format. See https://github.com/vitejs/vite/blob/main/.github/workflows/publish.yml (we also have another workflow that does a github release on listening to the same event, but that is also not necessary if you don't want). This is a easier flow because you directly release from your CLI with a commit and every published commit is clearly marked in GitHub with a tag.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea I was inspired by vite's workflow, and more importantly, the vite-ecosystem-ci workflow!

To be honest, I think publishing from workflow_dispatches, exactly next to cloudflare deploys would be way better. And then we can create tags (i'll add it in next commits then, I agree).

what do you think?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is better to release from a tag instead like we do in Vite because then you force yourself to only publish properly tagged versions. I think it is useful to have this tagged commit also be the one that is doing the bump. So all is connected.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see, you mean just a git push origin tag v0.0.18 would trigger a release?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

where would the change of the package.json version would be handled?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I think we can do that but don't we block direct pushes to main?

So we cannot do things with one command alone. Wdyt?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can unblock direct pushes to main if that is an issue. We would still have the approval flow to decide if that push will end up or not published, so it is fine.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just pushed a new commit, let me know what you think.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm good with this if vite releases works for you. It is very opinionated for the packages in the Vite repo, so probably better to use something more common, but let's go with this for now.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yea it works for our case, not heavily tested though since we need to try all the workflow in the main branch.


jobs:
deploy:
runs-on: ubuntu-latest
name: Deploy
environment: ${{ github.ref_name == 'release' && 'Production' || 'Staging' }}
environment: ${{ github.event_name == 'workflow_dispatch' && 'Production' || 'Staging' }}
outputs:
deployment-url: ${{ steps.deploy.outputs.deployment-url}}
steps:
Expand All @@ -37,6 +47,35 @@ jobs:
DEPLOYMENT_URL: ${{ steps.deploy.outputs.deployment-url }}
run: echo $DEPLOYMENT_URL

release:
runs-on: ubuntu-latest
if: ${{ github.event_name == 'workflow_dispatch' }}
needs: deploy

steps:
- uses: actions/checkout@v4
- run: corepack enable
- uses: actions/setup-node@v4
with:
node-version: 20
cache: "pnpm"
- run: pnpm install

- id: release
run: |
pnpm build:publish
echo "version=$(npm version ${{ inputs.version }})" >> "$GITHUB_OUTPUT"
npm publish --access public
working-directory: ./packages/cli
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

- uses: EndBug/add-and-commit@v9
with:
default_author: github_actions
add: 'packages/cli/package.json' # commit the new version
message: '${{ steps.release.outputs.version }}'

cr:
concurrency:
group: continuous-releases
Expand Down Expand Up @@ -64,7 +103,7 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- run: pnpm tsx script/update-webhook-url.ts
if: ${{ github.ref_name != 'release' }}
if: ${{ github.event_name != 'workflow_dispatch' }}
working-directory: ./packages/backend
env:
API_URL: ${{ needs.deploy.outputs.deployment-url }}
Expand Down