-
Notifications
You must be signed in to change notification settings - Fork 12.3k
Add workflow to release upgradeable package #6015
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.
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
base: master
Are you sure you want to change the base?
Changes from 7 commits
8b5132b
a252b22
870e714
649a635
0c2dab8
259c56e
40a76ef
aa1b25a
b096f3b
e004cb0
9581bae
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,46 @@ | ||||||
| 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: | ||||||
| VANILLA_REPO: OpenZeppelin/openzeppelin-contracts | ||||||
| UPGRADEABLE_REPO: james-toussaint/openzeppelin-contracts-upgradeable # TODO: Update repo before merging | ||||||
| steps: | ||||||
| - run: echo "UPGRADEABLE_DIR=${GITHUB_WORKSPACE}/upgradeable" >> "$GITHUB_ENV" | ||||||
|
||||||
| - run: echo "UPGRADEABLE_DIR=${GITHUB_WORKSPACE}/upgradeable" >> "$GITHUB_ENV" | |
| - run: echo "UPGRADEABLE_DIR=${GITHUB_WORKSPACE}/${{ github.event.inputs.upgradeable-path }}" >> "$GITHUB_ENV" |
And:
- uses: actions/checkout@v5
with:
repository: ${{ env.UPGRADEABLE_REPO }}
submodules: true
token: ${{ secrets.GH_TOKEN_UPGRADEABLE }}
ref: ${{ github.ref }}
path: ${{ github.event.inputs.upgradeable-path }}This way we keep the value consistent across where it's used
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, on a second thought I think the path should be provided for the vanilla repository instead, this way we can echo "commit=$(git rev-parse --short HEAD)" >> "$GITHUB_OUTPUT" && cd "${UPGRADEABLE_DIR}", then just continue normally.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See Use vanilla dir.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
james-toussaint marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| gh release create "${GIT_TAG}" \ | ||
| --repo="${UPGRADEABLE_REPO}" \ | ||
| --title="${GIT_TAG}" \ | ||
| --notes="$(gh release view "${OLD_GIT_TAG}" --repo="${VANILLA_REPO}" --json body -q .body)" `# TODO: Update tag before merging` \ | ||
| "${ADDITIONAL_OPTION_IF_PRERELEASE}" | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
james-toussaint marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| cd $UPGRADEABLE_DIR | ||
|
|
||
| if ! git log -1 --pretty=%B | grep -q "Transpile ${VANILLA_COMMIT}"; then | ||
| echo "Expected 'Transpile ${VANILLA_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" | ||
| ADDITIONAL_OPTION_IF_PRERELEASE="--prerelease" | ||
| if [[ "${GIT_TAG}" =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then | ||
| NPM_TAG="dev" | ||
| ADDITIONAL_OPTION_IF_PRERELEASE="" | ||
| elif [[ "${GIT_TAG}" =~ ^v[0-9]+\.[0-9]+\.[0-9]+-rc.[0-9]+$ ]]; then | ||
| NPM_TAG="next" | ||
| fi | ||
| echo "additional_option_if_prerelease=${ADDITIONAL_OPTION_IF_PRERELEASE}" >> "$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] | ||
| 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) | ||
| git tag -m {,}"${GIT_TAG}" | ||
| CI=true git push origin tag "${GIT_TAG}" | ||
| npm ci | ||
| cd "contracts/" | ||
| npm publish --tag "${NPM_TAG}" | ||
| echo "git_tag=${GIT_TAG}" >> "$GITHUB_OUTPUT" | ||
Uh oh!
There was an error while loading. Please reload this page.