Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
52 changes: 52 additions & 0 deletions .github/workflows/release-upgradeable.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Release Upgradeable

on:
workflow_dispatch: {}

jobs:
release-upgradeable:
environment: push-upgradeable
permissions:
id-token: write # Required for OIDC
contents: read
runs-on: ubuntu-latest
env:
REFERENCE_REPO: OpenZeppelin/openzeppelin-contracts
UPGRADEABLE_REPO: james-toussaint/openzeppelin-contracts-upgradeable # TODO: Update repo before merging
steps:
- uses: actions/checkout@v5
with:
repository: ${{ env.UPGRADEABLE_REPO }}
submodules: true
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
submodules: true

token: ${{ secrets.GH_TOKEN_UPGRADEABLE }}
Copy link
Collaborator

Choose a reason for hiding this comment

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

we shouldn't need that for checkout

Suggested change
token: ${{ secrets.GH_TOKEN_UPGRADEABLE }}

ref: ${{ github.ref }}
- uses: actions/checkout@v5
with:
repository: ${{ env.REFERENCE_REPO }}
ref: ${{ github.ref }}
path: reference
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
path: reference
path: lib/openzeppelin

- name: Get reference commit
id: get-reference-commit
run: cd reference && echo "commit=$(git rev-parse --short HEAD)" >> "$GITHUB_OUTPUT"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
run: cd reference && echo "commit=$(git rev-parse --short HEAD)" >> "$GITHUB_OUTPUT"
run: |
cd reference
echo "commit=$(git rev-parse --short HEAD)" >> "$GITHUB_OUTPUT"

- uses: actions/checkout@v5 # TODO: Remove this before merging (used to get scripts added in this PR)
with:
path: reference
Comment on lines +31 to +33
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- uses: actions/checkout@v5 # TODO: Remove this before merging (used to get scripts added in this PR)
with:
path: reference

- name: Set up environment
uses: ./reference/.github/actions/setup
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
uses: ./reference/.github/actions/setup
uses: ./.github/actions/setup

- name: Check upgradeable
id: check-upgradeable
run: bash reference/scripts/release/workflow/check-upgradeable.sh
Copy link
Collaborator

@Amxx Amxx Dec 17, 2025

Choose a reason for hiding this comment

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

Suggested change
run: bash reference/scripts/release/workflow/check-upgradeable.sh
run: bash lib/openzeppelin/scripts/release/workflow/check-upgradeable.sh

env:
REFERENCE_COMMIT: ${{ steps.get-reference-commit.outputs.commit }}
- name: Publish upgradeable contracts
id: publish
Copy link
Collaborator

Choose a reason for hiding this comment

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

is that id needed ?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
id: publish

run: bash reference/scripts/release/workflow/publish-upgradeable.sh
Copy link
Collaborator

@Amxx Amxx Dec 17, 2025

Choose a reason for hiding this comment

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

Suggested change
run: bash reference/scripts/release/workflow/publish-upgradeable.sh
run: bash lib/openzeppelin/scripts/release/workflow/publish-upgradeable.sh

env:
NPM_TAG: ${{ steps.check-upgradeable.outputs.npm_tag }}
Comment on lines +43 to +45
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
run: bash reference/scripts/release/workflow/publish-upgradeable.sh
env:
NPM_TAG: ${{ steps.check-upgradeable.outputs.npm_tag }}
run: |
cd "contracts/"
npm publish --tag ${{ steps.check-upgradeable.outputs.npm_tag }}

- name: Create Github Release Note
run: bash reference/scripts/release/workflow/github-release-upgradeable.sh
Copy link
Collaborator

@Amxx Amxx Dec 17, 2025

Choose a reason for hiding this comment

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

Suggested change
run: bash reference/scripts/release/workflow/github-release-upgradeable.sh
run: bash lib/openzeppelin/scripts/release/workflow/github-release-upgradeable.sh

env:
GITHUB_TOKEN: ${{ secrets.GH_TOKEN_UPGRADEABLE }}
GIT_TAG: ${{ steps.check-upgradeable.outputs.git_tag }}
RELEASE_COMMIT: ${{ steps.check-upgradeable.outputs.release_commit }}
PRERELEASE: ${{ steps.check-upgradeable.outputs.prerelease }}
29 changes: 29 additions & 0 deletions scripts/release/workflow/check-upgradeable.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
#!/usr/bin/env bash

set -euo pipefail

echo "release_commit=$(git log -1 --pretty=%H)" >> "$GITHUB_OUTPUT"
if ! git log -1 --pretty=%B | grep -q "Transpile ${REFERENCE_COMMIT}"; then
echo "Expected 'Transpile ${REFERENCE_COMMIT}' but found '$(git log -1 --pretty=%B)'"
exit 1
fi
VERSION="$(jq -r .version contracts/package.json)"
GIT_TAG="v${VERSION}"
NPM_TAG="tmp"
PRERELEASE="true"
if [[ "${GIT_TAG}" =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
NPM_TAG="dev"
PRERELEASE="false"
elif [[ "${GIT_TAG}" =~ ^v[0-9]+\.[0-9]+\.[0-9]+-rc.[0-9]+$ ]]; then
NPM_TAG="next"
fi
echo "prerelease=${PRERELEASE}" >> "$GITHUB_OUTPUT"
echo "npm_tag=${NPM_TAG}" >> "$GITHUB_OUTPUT"
### [START BLOCK] TODO: Remove block before merging
TIMESTAMPED_VERSION="${VERSION}-$(date +%s)"
echo "OLD_GIT_TAG=${GIT_TAG}" >> "$GITHUB_ENV"
GIT_TAG="${GIT_TAG}-$(date +%s)" # incremental git tag for testing
sed -i'' -e 's/openzeppelin\/contracts-upgradeable/james-toussaint\/contracts-upgradeable/g' contracts/package.json # custom scope for testing
sed -i'' -e "s/${VERSION}/${TIMESTAMPED_VERSION}/g" contracts/package.json && head contracts/package.json # incremental npm package version for testing
### [END BLOCK]
echo "git_tag=${GIT_TAG}" >> "$GITHUB_OUTPUT"
10 changes: 10 additions & 0 deletions scripts/release/workflow/github-release-upgradeable.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
#!/usr/bin/env bash

set -euo pipefail

gh release create "${GIT_TAG}" \
--repo="${UPGRADEABLE_REPO}" \
--title="${GIT_TAG}" \
--target="${RELEASE_COMMIT}" \
--notes="$(gh release view "${OLD_GIT_TAG}" --repo="${REFERENCE_REPO}" --json body -q .body)" `# TODO: Update tag before merging` \
--prerelease="${PRERELEASE}"
7 changes: 7 additions & 0 deletions scripts/release/workflow/publish-upgradeable.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/usr/bin/env bash

set -euo pipefail

sed -i'' -e 's/OpenZeppelin\/openzeppelin-contracts-upgradeable/james-toussaint\/openzeppelin-contracts/g' contracts/package.json # repository.url for provenance (TODO: Update and try keep upgradeable url)
cd "contracts/"
npm publish --tag "${NPM_TAG}"