Skip to content

Prepare for a 0.13.0 release #1094

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

Merged
merged 5 commits into from
Aug 4, 2020

Conversation

joshuagl
Copy link
Member

Fixes issue #: N/A

Description of the changes being introduced by the pull request:

  • Add a document describing the release process
  • prepare docs/CHANGELOG.md, setup.cfg and tuf/init.py for a 0.13.0 release

Please verify and check that the pull request fulfills the following
requirements
:

  • The code follows the Code Style Guidelines
  • Tests have been added for the bug fix or new feature
  • Docs have been added for the bug fix or new feature

* create source dist `python setup.py sdist`
* create wheel (with 2 and 3 support) `python setup.py bdist_wheel --universal`
* Sign the dists `gpg --detach-sign -a dist/tuf-vA.B.C.tar.gz`
* Upload to test PyPI `twine upload --repository testpypi dist/*`
Copy link
Member Author

Choose a reason for hiding this comment

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

Can't currently perform this step, as @vladimir-v-diaz is the owner of that package on test.pypi.org

Copy link
Member

@lukpueh lukpueh left a comment

Choose a reason for hiding this comment

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

Many thanks for preparing this release, and big kudos for adding a RELEASE.md document, @joshuagl. ❤️
The former definitely looks good to me. I double-checked that all PR numbers point to the right PR and no important PRs were omitted. You only left out dependabot PRs and a few minor changes that probably could be added to the changelog but don't need to, i.e. #1021 #1028 #1044 #1051 #1072 #1086. Maybe double-check if you left them out on purpose or not.

In RELEASE.md I left a few comments, feel free to address as you see fit. Thanks!

@trishankatdatadog
Copy link
Member

Many thanks for preparing this release, and big kudos for adding a RELEASE.md document, @joshuagl. ❤️

💯 💯

QQ: would it be possible to formalize RELEASE.md with a script?

@trishankatdatadog
Copy link
Member

trishankatdatadog commented Aug 4, 2020

I would also probably hold off until we merge some important fixes, including #1091

@joshuagl
Copy link
Member Author

joshuagl commented Aug 4, 2020

Many thanks for preparing this release, and big kudos for adding a RELEASE.md document, @joshuagl. ❤️
The former definitely looks good to me. I double-checked that all PR numbers point to the right PR and no important PRs were omitted. You only left out dependabot PRs and a few minor changes that probably could be added to the changelog but don't need to, i.e. #1021 #1028 #1044 #1051 #1072 #1086. Maybe double-check if you left them out on purpose or not.

In RELEASE.md I left a few comments, feel free to address as you see fit. Thanks!

I may have missed, #1072, but mostly those PRs were things I opted to ignore because I didn't think they were particularly interesting. I'd be happy to include the PRs you mentioned, or not, and add some additional text to RELEASE.md to guide future CHANGELOG.md editors in curating a set of changes that better matches expectations.

Personally I prefer a changelog to include notable changes, rather than all changes. However I realise even that is subjective and there are entries I added to the changelog for this release that don't meet my own criteria for notable.

I welcome thoughts on changelog curation. In the past I've followed similar principles to https://keepachangelog.com/, which would suggest editing the changelog here to group similar changes and clearly delineate new features, changed features, fixes, security issues, etc.

@joshuagl
Copy link
Member Author

joshuagl commented Aug 4, 2020

Many thanks for preparing this release, and big kudos for adding a RELEASE.md document, @joshuagl. ❤️

💯 💯

QQ: would it be possible to formalize RELEASE.md with a script?

Agreed, scripting some of this would be good. I'll take a look at that in future.

@joshuagl
Copy link
Member Author

joshuagl commented Aug 4, 2020

I would also probably hold off until we merge some important fixes, including #1091

I'm hoping to get into the habit of releasing more regularly. docs/ROADMAP.md suggests the project releases every 3 months. I'd like to get closer to that, so I don't think in general we should worry too much about holding a release for fixes.

#1091 specifically, though, I'd be happy to merge and include in the release

Write down the expected steps for a maintainer to follow when making a
release of tuf

Signed-off-by: Joshua Lock <[email protected]>
Signed-off-by: Joshua Lock <[email protected]>
https://keepachangelog.com provides good advice on curating a changelog

Signed-off-by: Joshua Lock <[email protected]>
@joshuagl
Copy link
Member Author

joshuagl commented Aug 4, 2020

#1091 specifically, though, I'd be happy to merge and include in the release

I've merged this PR and included it in docs/CHANGELOG.md

@lukpueh
Copy link
Member

lukpueh commented Aug 4, 2020

I may have missed, #1072, but mostly those PRs were things I opted to ignore because I didn't think they were particularly interesting. I'd be happy to include the PRs you mentioned, or not, and add some additional text to RELEASE.md to guide future CHANGELOG.md editors in curating a set of changes that better matches expectations.

Personally I prefer a changelog to include notable changes, rather than all changes. However I realise even that is subjective and there are entries I added to the changelog for this release that don't meet my own criteria for notable.

I welcome thoughts on changelog curation. In the past I've followed similar principles to https://keepachangelog.com/, which would suggest editing the changelog here to group similar changes and clearly delineate new features, changed features, fixes, security issues, etc.

👍 This all makes sense and aligns with what I thought. Just wanted to double-check. :) Thanks for adding a link to the changelog guide to RELEASE.md.

Categorise changes by type, per the recommendations at keepachangelog.com

Signed-off-by: Joshua Lock <[email protected]>
Copy link
Member

@lukpueh lukpueh left a comment

Choose a reason for hiding this comment

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

💯

@lukpueh lukpueh merged commit 7a418a2 into theupdateframework:develop Aug 4, 2020
@joshuagl joshuagl deleted the joshuagl/v0.13.0 branch August 4, 2020 13:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants