Skip to content

Commit d9f169e

Browse files
committed
ReleaseChecklist: Consistently use double backticks everywhere, fix indents and mismatched parentheses
1 parent 3388305 commit d9f169e

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

ReleaseChecklist.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
### Requirements
44
- [ ] Lauchpad (Ubuntu One) account
5-
- [ ] gnupg key (has to be version 1, gpg2 won't work) for `[email protected]` created and uploaded
5+
- [ ] gnupg key (has to be version 1, gpg2 won't work) for ``[email protected]`` created and uploaded
66
- [ ] Write access to https://github.com/ethereum/homebrew-ethereum
77

88
### Blog Post
99
- [ ] Create a post on [solidity-blog](https://github.com/ethereum/solidity-blog) in the ``Releases`` category and explain some of the new features or concepts.
1010
- [ ] Create a post on [solidity-blog](https://github.com/ethereum/solidity-blog) in the ``Security Alerts`` category in case of important bug(s).
1111

1212
### Documentation check
13-
- [ ] Run `make linkcheck` from within `docs/` and fix any broken links it finds. Ignore false positives caused by `href` anchors and dummy links not meant to work.
13+
- [ ] Run ``make linkcheck`` from within ``docs/`` and fix any broken links it finds. Ignore false positives caused by ``href`` anchors and dummy links not meant to work.
1414

1515
### Changelog
1616
- [ ] Sort the changelog entries alphabetically and correct any errors you notice. Commit it.
@@ -22,12 +22,12 @@
2222

2323
### Create the Release
2424
- [ ] Create a [release on github](https://github.com/ethereum/solidity/releases/new).
25-
Set the target to the ``develop`` branch and the tag to the new version, e.g. `v0.8.5`.
25+
Set the target to the ``develop`` branch and the tag to the new version, e.g. ``v0.8.5``.
2626
Include the following warning: ``**The release is still in progress and the binaries may not yet be available from all sources.**``.
2727
Don't publish it yet - click the ``Save draft`` button instead.
2828
- [ ] Thank voluntary contributors in the Github release notes (use ``git shortlog -s -n -e v0.5.3..origin/develop``).
2929
- [ ] Check that all tests on the latest commit in ``develop`` are green.
30-
- [ ] Click the `Publish release` button on the release page, creating the tag.
30+
- [ ] Click the ``Publish release`` button on the release page, creating the tag.
3131
- [ ] Wait for the CI runs on the tag itself.
3232

3333
### Upload Release Artifacts and Publish Binaries
@@ -36,7 +36,7 @@
3636
- [ ] Run ``scripts/create_source_tarball.sh`` while being on the tag to create the source tarball. This will create the tarball in a directory called ``upload``.
3737
- [ ] Take the tarball from the upload directory (its name should be ``solidity_x.x.x.tar.gz``, otherwise ``prerelease.txt`` was missing in the step before) and upload the source tarball to the release page.
3838
- [ ] Take the ``github-binaries.tar`` tarball from ``c_release_binaries`` run of the tagged commit in circle-ci and add all binaries from it to the release page.
39-
Make sure it contains four binaries: ``solc-windows.exe``, ``solc-macos``, ``solc-static-linux`` and ``soljson.js``.
39+
Make sure it contains four binaries: ``solc-windows.exe``, ``solc-macos``, ``solc-static-linux`` and ``soljson.js``.
4040
- [ ] Take the ``solc-bin-binaries.tar`` tarball from ``c_release_binaries`` run of the tagged commit in circle-ci and add all binaries from it to solc-bin.
4141
- [ ] Run ``./update --reuse-hashes`` in ``solc-bin`` and verify that the script has updated ``list.js``, ``list.txt`` and ``list.json`` files correctly and that symlinks to the new release have been added in ``solc-bin/wasm/`` and ``solc-bin/emscripten-wasm32/``.
4242
- [ ] Create a pull request in solc-bin and merge.
@@ -46,13 +46,17 @@
4646
- [ ] Update the version and the hash (``sha256sum solidity_$VERSION.tar.gz``) in https://github.com/ethereum/homebrew-ethereum/blob/master/solidity.rb
4747

4848
### Docker
49-
- [ ] Run ``./scripts/docker_deploy_manual.sh v$VERSION``).
49+
- [ ] Run ``./scripts/docker_deploy_manual.sh v$VERSION``.
5050

5151
### PPA
52-
- [ ] Make sure the ``ethereum/cpp-build-deps`` PPA repository contains libz3-static-dev builds for all current versions of ubuntu. If not run ``scripts/deps-ppa/static-z3.sh`` (after changing email address and key id and adding the missing ubuntu version) and wait for the builds to succeed before continuing.
52+
- [ ] Make sure the ``ethereum/cpp-build-deps`` PPA repository contains ``libz3-static-dev builds`` for all current versions of ubuntu.
53+
If not run ``scripts/deps-ppa/static-z3.sh`` (after changing email address and key id and adding the missing ubuntu version) and wait for the builds to succeed before continuing.
5354
- [ ] Change ``scripts/release_ppa.sh`` to match your key's email and key id; double-check that ``DISTRIBUTIONS`` contains the most recent versions.
5455
- [ ] Run ``scripts/release_ppa.sh v$VERSION`` to create the PPA release (you need the relevant openssl key).
55-
- [ ] Wait for the ``~ethereum/ubuntu/ethereum-static`` PPA build to be finished and published for *all platforms*. SERIOUSLY: DO NOT PROCEED EARLIER!!! *After* the static builds are *published*, copy the static package to the ``~ethereum/ubuntu/ethereum`` PPA for the destination series ``Trusty``, ``Xenial`` and ``Bionic`` while selecting ``Copy existing binaries``.
56+
- [ ] Wait for the ``~ethereum/ubuntu/ethereum-static`` PPA build to be finished and published for *all platforms*.
57+
**SERIOUSLY: DO NOT PROCEED EARLIER!!!**
58+
*After* the static builds are *published*, copy the static package to the ``~ethereum/ubuntu/ethereum`` PPA
59+
for the destination series ``Trusty``, ``Xenial`` and ``Bionic`` while selecting ``Copy existing binaries``.
5660

5761
### Release solc-js
5862
- [ ] Wait until solc-bin was properly deployed. You can test this via remix - a test run through remix is advisable anyway.

0 commit comments

Comments
 (0)