Skip to content

Conversation

@cameel
Copy link
Collaborator

@cameel cameel commented Aug 8, 2022

Some tweaks to the checklist based on our experience with this release.

  • Docs get built automatically so looks like we no longer need separate steps for RTD. We should verify that with @chriseth though.
  • In practice we never run full tests.sh. I updated that point to say only to run the buglist update script.
  • Clarification regarding changelog and version commits.
  • Warning on the release page and more detailed steps for blog posts.

@cameel cameel self-assigned this Aug 8, 2022
@cameel cameel dismissed a stale review via 5073ecd August 9, 2022 08:57
@cameel cameel force-pushed the release-checklist-update-and-tweaks branch from 6a9e706 to 5073ecd Compare August 9, 2022 08:57
@cameel cameel dismissed a stale review via 4454201 August 9, 2022 09:26
@cameel cameel force-pushed the release-checklist-update-and-tweaks branch 3 times, most recently from bba4711 to 9b4ab06 Compare August 9, 2022 09:42
Copy link
Contributor

@franzihei franzihei left a comment

Choose a reason for hiding this comment

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

Added some details re. communications

ekpyron
ekpyron previously approved these changes Aug 10, 2022
Copy link
Collaborator

@ekpyron ekpyron left a comment

Choose a reason for hiding this comment

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

Some nitpicking comments :-). But we can also just merge.

- [ ] Lauchpad (Ubuntu One) account
- [ ] gnupg key (has to be version 1, gpg2 won't work) for `your-name@ethereum.org` created and uploaded
- [ ] Readthedocs account, access to the Solidity project
- [ ] gnupg key (has to be version 1, gpg2 won't work) for ``your-name@ethereum.org`` created and uploaded
Copy link
Collaborator

Choose a reason for hiding this comment

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

Not entire clear what to do with that key... i.e. we could merge this with the previous point (Are gpg keys required for anything but launchpad? Nothing comes to my mind.)

Copy link
Collaborator Author

@cameel cameel Aug 11, 2022

Choose a reason for hiding this comment

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

Good point. I think that's the only thing. Unless dockerhub also requires it (I don't have access to that) but I doubt it.

While at it I also added other requirements: all repos, npm, dockerhub, twitter, reddit, etc. Check it out.

Copy link
Contributor

Choose a reason for hiding this comment

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

I mean, if enough ppl have keys, we could start signing our commits?

Copy link
Contributor

Choose a reason for hiding this comment

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

(just thinking about other cases where they are useful)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Probably. I wonder how that works with rebases though. Doesn't this invalidate signatures?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think the sentiment in the past was that signed commits aren't really all that useful in general :-).

@cameel cameel force-pushed the release-checklist-update-and-tweaks branch 6 times, most recently from 2f900fc to b3af578 Compare August 11, 2022 12:51
- [ ] Github account with access to [solidity](https://github.com/ethereum/solidity), [solc-js](https://github.com/ethereum/solc-js),
[solc-bin](https://github.com/ethereum/solc-bin), [homebrew-ethereum](https://github.com/ethereum/homebrew-ethereum),
[solidity-blog](https://github.com/ethereum/solidity-blog) and [solidity-portal](https://github.com/ethereum/solidity-portal) repositories.
- [ ] DockerHub account with push rights to the [``solc`` image](https://hub.docker.com/r/ethereum/solc).
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I don't have dockerhub account so not sure how that works in details. Do you need access to a specific image or do you just need to be a member of the ethereum organization?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think being part of the ethereum organization is sufficient. But ultimately what you happens is that you'll push the solc image, so I'd say the current phrasing is fine.

@ekpyron
Copy link
Collaborator

ekpyron commented Aug 12, 2022

I just merged #13370, so would be nice to tweak the checklist for that here as well.

@cameel cameel dismissed a stale review via b27c521 August 16, 2022 10:54
@cameel cameel force-pushed the release-checklist-update-and-tweaks branch 4 times, most recently from 02b7025 to 510300d Compare August 16, 2022 10:58
- [ ] Create ``.release_ppa_auth`` at the root of your local Solidity checkout and set ``LAUNCHPAD_EMAIL`` and ``LAUNCHPAD_KEYID`` to your key's email and key id.
- [ ] Double-check that the ``DISTRIBUTIONS`` list in ``scripts/release_ppa.sh`` and ``scripts/deps-ppa/static-z3.sh`` contains the most recent versions of Ubuntu.
- [ ] Make sure the [``~ethereum/cpp-build-deps`` PPA repository](https://launchpad.net/~ethereum/+archive/ubuntu/cpp-build-deps) 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 wait for the builds to succeed before continuing.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@Marenz I just realized that #13370 did not cover scripts/deps-ppa/static-z3.sh so it still has a hard-coded key and e-mail. I think we should have them both working the same way.

- [ ] Double-check that the ``DISTRIBUTIONS`` list in ``scripts/release_ppa.sh`` and ``scripts/deps-ppa/static-z3.sh`` contains the most recent versions of Ubuntu.
- [ ] Make sure the [``~ethereum/cpp-build-deps`` PPA repository](https://launchpad.net/~ethereum/+archive/ubuntu/cpp-build-deps) 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 wait for the builds to succeed before continuing.
- [ ] Run ``scripts/release_ppa.sh v$VERSION`` to create the PPA release (you need the relevant openssl key).
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@Marenz What key is it referencing? Does it mean GPG key or did you actually need some OpenSSL key here?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, I am not sure what ssl keys are meant here, as far as I know I only needed the gpg keys registered with launchpad

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

OK, I'm removing this bit in that case.

@cameel cameel force-pushed the release-checklist-update-and-tweaks branch from 510300d to 262617b Compare August 24, 2022 18:25
matheusaaguiar
matheusaaguiar previously approved these changes Aug 24, 2022
@matheusaaguiar matheusaaguiar dismissed their stale review August 24, 2022 18:45

mistakenly approved early

@cameel cameel added the priority review We want this get the review of this PR to a conclusion ASAP. label Aug 25, 2022
Copy link
Collaborator

@matheusaaguiar matheusaaguiar left a comment

Choose a reason for hiding this comment

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

I noticed that there are 3 "raw" urls in the text while others were wrapped in hyperlinks. Probably we want to do this with these remaining ones.

@cameel cameel force-pushed the release-checklist-update-and-tweaks branch from 262617b to ccc3317 Compare September 5, 2022 16:20
@ekpyron ekpyron merged commit 62e4ce3 into develop Sep 5, 2022
@ekpyron ekpyron deleted the release-checklist-update-and-tweaks branch September 5, 2022 17:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation 📖 priority review We want this get the review of this PR to a conclusion ASAP.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants