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

Write 1.0 changelog / release notes #1845

Closed
jku opened this issue Feb 9, 2022 · 4 comments · Fixed by #1873
Closed

Write 1.0 changelog / release notes #1845

jku opened this issue Feb 9, 2022 · 4 comments · Fixed by #1873
Assignees
@jku
Labels
1.0.0 blockers To be addressed before 1.0.0 release
Milestone
sprint 17

Comments

@jku
Copy link
Member

jku commented Feb 9, 2022

In preparation for release, start working on changelog
@jku jku added the 1.0.0 blockers To be addressed before 1.0.0 release label Feb 9, 2022
@jku jku added this to the sprint 17 milestone Feb 9, 2022
@jku jku self-assigned this Feb 9, 2022
@lukpueh
Copy link
Member

lukpueh commented Feb 9, 2022

Some open questions: Do we need release notes in addition to the changelog? Should we just add a release note preamble to the 1.0.0 changelog entry? Is it enough if that just links to the existing 1.0.0 release announcement (coordinate with #1795)?

@jku jku linked a pull request Feb 18, 2022 that will close this issue
Changelog: Add 1.0 changes #1851
Closed
@jku
Copy link
Member Author

jku commented Feb 18, 2022

Some open questions: Do we need release notes in addition to the changelog? Should we just add a release note preamble to the 1.0.0 changelog entry? Is it enough if that just links to the existing 1.0.0 release announcement (coordinate with #1795)?

Status and some thoughts:

  • we'll have blog post(s) for announcement
  • I don't think the changelog needs more but it would be nice to include a link to the announcement... but that seems like a tricky cyclical dependancy :)
  • we can add the announcement link to the Github release page afterwards, and could even edit the changelog file afterwards
  • We could even link to the announcement from README, at least for a time

Suggestion: let's leave it as is, and after we have the announcement up somewhere (after the release is made), add a link to the github release page and possibly the changelog file?

@lukpueh
Copy link
Member

lukpueh commented Feb 18, 2022

Shall we close this issue now, or with #1873?

@jku jku linked a pull request Feb 18, 2022 that will close this issue
1.0.0 release #1873
Merged
@jku
Copy link
Member Author

jku commented Feb 18, 2022

linked, thanks

@jku jku closed this as completed in #1873 Feb 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jku jku

Labels
1.0.0 blockers To be addressed before 1.0.0 release
Projects
None yet
Milestone
sprint 17
Development

Successfully merging a pull request may close this issue.

1.0.0 release jku/python-tuf
Changelog: Add 1.0 changes jku/python-tuf
2 participants
@jku @lukpueh