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

Update release checklist: homebrew and solc-js instructions #15494

Closed
wants to merge 3 commits into from
Closed

Update release checklist: homebrew and solc-js instructions #15494

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3ac688e
Update release checklist
nikola-matic Oct 9, 2024
3387abd
Add detailed description of homebrew formula update
r0qs Oct 9, 2024
e42906b
Include a link to the documentation for testing soljson.js
r0qs Oct 9, 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
16 changes: 15 additions & 1 deletion ReleaseChecklist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,20 @@ At least a day before the release:
- [ ] Create a pull request in solc-bin and merge.

### Homebrew and MacOS
- [ ] Update the version and the hash (``sha256sum solidity_$VERSION.tar.gz``) in the [``solidity`` formula in Homebrew core repository](https://github.com/Homebrew/homebrew-core/blob/master/Formula/solidity.rb).
- [ ] Create a local fork of the repository at ``[email protected]:Homebrew/homebrew-core.git``
- [ ] Make sure that ``brew`` is installed on your system, or use the official Homebrew docker container:
``docker run --interactive --tty --rm --pull always --volume "$(pwd):/homebrew-core" --workdir "/homebrew-core" homebrew/ubuntu22.04:latest /bin/bash``
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
``docker run --interactive --tty --rm --pull always --volume "$(pwd):/homebrew-core" --workdir "/homebrew-core" homebrew/ubuntu22.04:latest /bin/bash``
``docker run --interactive --tty --rm --pull always --volume "$PWD:/homebrew-core" --workdir /homebrew-core homebrew/ubuntu22.04``

#### Manual Update
- [ ] Open the [``solidity`` formula in Homebrew core repository](https://github.com/Homebrew/homebrew-core/blob/master/Formula/s/solidity.rb) using your preferred text editor and update the following fields:
- url: Update the URL to reflect the new source file for the updated version.
Comment on lines +80 to +84
Copy link
Member

Choose a reason for hiding this comment

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

Spacing and indentation is off here:

Suggested change
- [ ] Make sure that ``brew`` is installed on your system, or use the official Homebrew docker container:
``docker run --interactive --tty --rm --pull always --volume "$(pwd):/homebrew-core" --workdir "/homebrew-core" homebrew/ubuntu22.04:latest /bin/bash``
#### Manual Update
- [ ] Open the [``solidity`` formula in Homebrew core repository](https://github.com/Homebrew/homebrew-core/blob/master/Formula/s/solidity.rb) using your preferred text editor and update the following fields:
- url: Update the URL to reflect the new source file for the updated version.
- [ ] Make sure that ``brew`` is installed on your system, or use the official Homebrew docker container:
``docker run --interactive --tty --rm --pull always --volume "$(pwd):/homebrew-core" --workdir "/homebrew-core" homebrew/ubuntu22.04:latest /bin/bash``
#### Manual Update
- [ ] Open the [``solidity`` formula in Homebrew core repository](https://github.com/Homebrew/homebrew-core/blob/master/Formula/s/solidity.rb) using your preferred text editor and update the following fields:
- url: Update the URL to reflect the new source file for the updated version.

- sha256: Replace with the new SHA256 checksum of the source file. You can obtain it using a command like:
Comment on lines +84 to +85
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- url: Update the URL to reflect the new source file for the updated version.
- sha256: Replace with the new SHA256 checksum of the source file. You can obtain it using a command like:
- ``url``: Update the URL to reflect the new source file for the updated version.
- ``sha256``: Replace with the new SHA256 checksum of the source file. You can obtain it using a command like:

``curl -L https://github.com/ethereum/solidity/releases/download/v$VERSION/solidity_$VERSION.tar.gz | sha256sum``
- [ ] Test your changes locally by running the following command from the root directory of your fork: ``brew install --build-from-source ./Formula/s/solidity.rb``
- [ ] Open a PR in the Homebrew repository.
#### Automatic Update
- [ ] Create a GitHub token and run the following command: ``export HOMEBREW_GITHUB_API_TOKEN=your_token_here``
- [ ] Run the following command to automatically update the formula and create a PR in the Homebrew repository: ``brew bump-formula-pr --version=$VERSION solidity``
Note: the version should not include the prefix ``v``, e.g. ``X.Y.Z``.
Comment on lines +91 to +92
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- [ ] Run the following command to automatically update the formula and create a PR in the Homebrew repository: ``brew bump-formula-pr --version=$VERSION solidity``
Note: the version should not include the prefix ``v``, e.g. ``X.Y.Z``.
- [ ] Run the following command to automatically update the formula and create a PR in the Homebrew repository: ``brew bump-formula-pr --version=$VERSION solidity``.
Note: the version should not include the ``v`` prefix, i.e. ``X.Y.Z``.


### Docker
- [ ] Run ``./scripts/docker_deploy_manual.sh v$VERSION``.
Expand All @@ -103,6 +116,7 @@ At least a day before the release:
- [ ] Wait for the CI runs on the tag itself.
- [ ] Take the ``solc-x.y.z.tgz`` artifact from ``build-package`` run on the tagged commit in circle-ci.
Inspect the tarball to ensure that it contains an up-to-date compiler binary (``soljson.js``).
See the section "Testing version of soljson.js": https://github.com/ethereum/solidity/wiki/Building-solc%E2%80%90js-from-source#testing-version-of-soljsonjs
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
See the section "Testing version of soljson.js": https://github.com/ethereum/solidity/wiki/Building-solc%E2%80%90js-from-source#testing-version-of-soljsonjs
See the [Testing version of soljson.js](https://github.com/ethereum/solidity/wiki/Building-solc‐js-from-source#testing-version-of-soljsonjs) section on the wiki.

- [ ] Run ``npm publish solc-x.y.z.tgz`` to publish the newly created tarball.

### Post-release
Expand Down