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

Release helper script and CI #452

Merged
merged 12 commits into from
Dec 9, 2022
Merged

Release helper script and CI #452

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
4bc6c16
Remove container version
Half-Shot Nov 30, 2022
60645b8
Add release script
Half-Shot Nov 30, 2022
7b42c0b
Add
Half-Shot Nov 30, 2022
d97fc6e
Add npm publish script
Half-Shot Nov 30, 2022
909a601
Remove unused id
Half-Shot Nov 30, 2022
2f01c70
Testing tag publish
Half-Shot Nov 30, 2022
dde54a0
Commit the version
Half-Shot Nov 30, 2022
700db2f
Tidy up scripts
Half-Shot Nov 30, 2022
4ea75f2
Update release.yml
Half-Shot Nov 30, 2022
3ef9c2c
Update release.sh
Half-Shot Nov 30, 2022
7a6d4bb
Cleanup
Half-Shot Dec 8, 2022
710e698
changelog
Half-Shot Dec 8, 2022
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
18 changes: 18 additions & 0 deletions .github/workflows/npm-publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
on:
release:
types: [published]

jobs:
publish-to-npm:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Use Node.js
uses: actions/setup-node@v3
with:
node-version: 18
- run: yarn --strict-semver --frozen-lockfile
- run: yarn build
- uses: JS-DevTools/npm-publish@v1
with:
token: ${{ secrets.NPM_TOKEN }}
25 changes: 25 additions & 0 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@

on:
push:
tags: ["testing-[0-9].[0-9].[0-9]"]
AndrewFerr marked this conversation as resolved.
Show resolved Hide resolved

jobs:
draft-release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Get changelog
id: extract-changelog
run: |
git fetch --tags --force
RELEASE_NAME="${{ github.ref_name }} $(date +'%Y-%m-%d')"
git tag -l --format='%(contents:body)' ${{ github.ref_name }} > next-changelog.txt
echo "RELEASE_NAME=$RELEASE_NAME" >> $GITHUB_OUTPUT
- name: Create Release
uses: softprops/action-gh-release@v1
with:
tag_name: ${{ github.ref }}
name: ${{ steps.extract-changelog.outputs.RELEASE_NAME }}
body_path: next-changelog.txt
draft: true # Draft it
token: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
6 changes: 2 additions & 4 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ name: Tests
on:
push:
workflow_dispatch:
pull_request:

jobs:
lint:
Expand All @@ -12,7 +11,7 @@ jobs:
steps:
- uses: actions/checkout@v2
- name: Use Node.js
uses: actions/setup-node@v1
uses: actions/setup-node@v3
with:
node-version: 16
- run: yarn --strict-semver --frozen-lockfile
Expand All @@ -23,7 +22,6 @@ jobs:
matrix:
node-version: [16, 18]
runs-on: ubuntu-20.04
container: node:14
steps:
- uses: actions/checkout@v2
- name: Use Node.js
Expand Down Expand Up @@ -53,7 +51,7 @@ jobs:
steps:
- uses: actions/checkout@v2
- name: Use Node.js
uses: actions/setup-node@v1
uses: actions/setup-node@v3
with:
node-version: 18
- run: yarn --frozen-lockfile
Expand Down
5 changes: 0 additions & 5 deletions scripts/changelog-release.sh
View file
Open in desktop

This file was deleted.

41 changes: 41 additions & 0 deletions scripts/release.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
#!/bin/bash
# This script will run towncrier to generate a changelog entry.

VERSION=`python3 -c "import json; f = open('./package.json', 'r'); v = json.loads(f.read())['version']; f.close(); print(v)"`
TAG="$VERSION"

if [[ "`git branch --show-current`" != "develop" ]]; then
echo "You must be on the develop branch to run this command."
exit 1
fi

if [ $(git tag -l "$TAG") ]; then
echo "Tag $TAG already exists, not continuing."
exit 1
fi

echo "Drafting a new release"
towncrier build --draft --version $VERSION> draft-release.txt
cat draft-release.txt

read -p "Happy with the changelog? <y/N> " prompt
if [[ $prompt != "y" && $prompt != "Y" && $prompt != "yes" && $prompt != "Yes" ]]
then
exit 0
fi

echo "Committing version"
towncrier build --version $VERSION
git commit CHANGELOG.md changelog.d/ package.json -m $TAG

echo "Proceeding to generate tags"
cat draft-release.txt | git tag --force -m - -s $TAG
rm draft-release.txt
echo "Generated tag $TAG"

echo "Pushing to origin"
git push origin $TAG
Copy link
Contributor Author

@Half-Shot Half-Shot Nov 30, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

This obviously doesn't allow us to do a PR for releases, which may not be desirable. Thoughts on how this could be re-architected to support that are welcome. Alternatively we can forgo the PR.

Copy link
Member

Choose a reason for hiding this comment

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

PRs for releases can be a bit of a pain, and are probably redundant since we usually discuss release plans internally before publishing anything. So I'm in favour of forgoing.

# Push develop too
git push

echo "The CI to generate a release is now running. Check https://github.com/matrix-org/matrix-appservice-bridge/releases and publish the release when it's ready."