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.

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

docs: update CHANGELOG for 0.13.0 #254

Merged
merged 1 commit into from
Mar 28, 2024
Merged

docs: update CHANGELOG for 0.13.0 #254

merged 1 commit into from
Mar 28, 2024

Conversation

cpu
Copy link
Member

@cpu cpu commented Mar 25, 2024

I've included substantially more detail in this CHANGELOG update compared to previous. To try and keep the top level content manageable, while also balancing making updates as friction-less as possible, I've split off some separate migration help to its own document.

I've done my best to flag all of the important changes but would appreciate more eyes to make sure I haven't missed or misrepresented anything. Like previous updates I've called out contributions by external folks and not those by core maintainers.

@cpu cpu self-assigned this Mar 25, 2024
@cpu cpu requested review from djc and est31 March 25, 2024 19:28
@djc
Copy link
Member

djc commented Mar 25, 2024

I would reorder these with breaking changes before added and with both lists ordered from most to least impact.

@cpu
Copy link
Member Author

cpu commented Mar 25, 2024

I would reorder these with breaking changes before added and with both lists ordered from most to least impact.

Good idea. I've done a reordering pass.

Copy link
Member

@djc djc left a comment

Choose a reason for hiding this comment

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

Order looks great!

I think it's great to spend more words on the larger changes in the signing API, but (especially when also adding CRLs) I wonder if it could be done more concisely by explaining the general principles and abstracting as much as possible over certificate/CSR/CRL. I've tried hard to make the APIs as similar as possible for each of them.

I like to retain the () suffix on methods/functions because it makes it more obvious to distinguish these from types/variables.

rcgen/CHANGELOG.md Outdated Show resolved Hide resolved
rcgen/CHANGELOG.md Outdated Show resolved Hide resolved
rcgen/CHANGELOG.md Outdated Show resolved Hide resolved
rcgen/CHANGELOG.md Outdated Show resolved Hide resolved
@cpu
Copy link
Member Author

cpu commented Mar 25, 2024

I wonder if it could be done more concisely by explaining the general principles and abstracting as much as possible over certificate/CSR/CRL.

Yeah, I think that's good feedback 👍 I will try and rework along these lines tomorrow.

@cpu cpu force-pushed the cpu-0.13 branch 2 times, most recently from 0ec3f85 to b897e49 Compare March 26, 2024 19:08
@cpu
Copy link
Member Author

cpu commented Mar 26, 2024

I think it's great to spend more words on the larger changes in the signing API, but (especially when also adding CRLs) I wonder if it could be done more concisely by explaining the general principles and abstracting as much as possible over certificate/CSR/CRL. I've tried hard to make the APIs as similar as possible for each of them.

I went back and replaced the CHANGELOG.md coverage with a section aiming to explain the general principles without explicitly listing the mechanical changes. I think that's a good level of detail for a CHANGELOG and fits better with the existing practices.

But... I think the Rustls releases & feedback have shown me that there's also an audience for material that is much more explicit about what changed and what should be used instead. I've split off some of that content into a separate rcgen/docs/0.12-to-0.13.md document. It's probably overkill to do that for every release but I felt like it was worthwhile for this one. I'd like to try and make sure the process is as painless as possible for consumers.

I like to retain the () suffix on methods/functions because it makes it more obvious to distinguish these from types/variables.

Makes sense. I've done a pass adding them in both for the CHANGELOG and migration guide document.

rcgen/CHANGELOG.md Outdated Show resolved Hide resolved
rcgen/docs/0.12-to-0.13.md Outdated Show resolved Hide resolved
rcgen/docs/0.12-to-0.13.md Outdated Show resolved Hide resolved
@cpu cpu force-pushed the cpu-0.13 branch 2 times, most recently from 2834230 to ea07f2c Compare March 27, 2024 13:58
@cpu cpu marked this pull request as ready for review March 27, 2024 15:19
@cpu
Copy link
Member Author

cpu commented Mar 27, 2024

@est31 I think this is ready for review now and the last thing blocking a 0.13 release. If you're comfortable approving the branch can I go ahead and publish the release afterwards? It would be great if we could do this before your availability is reduced :-)

Copy link
Member

@est31 est31 left a comment

Choose a reason for hiding this comment

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

LGTM, let's release 0.13

@djc djc added this pull request to the merge queue Mar 28, 2024
Merged via the queue into rustls:main with commit 3daef5e Mar 28, 2024
15 checks passed
@djc
Copy link
Member

djc commented Mar 28, 2024

  • Created v0.13.0 tag
  • Published rcgen v0.13.0 at registry crates-io

@cpu cpu deleted the cpu-0.13 branch March 28, 2024 13:13
@cpu
Copy link
Member Author

cpu commented Mar 28, 2024

Thanks for finishing this up djc 🚀

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