-
Notifications
You must be signed in to change notification settings - Fork 113
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
Conversation
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. |
There was a problem hiding this 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.
Yeah, I think that's good feedback 👍 I will try and rework along these lines tomorrow. |
0ec3f85
to
b897e49
Compare
I went back and replaced the 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
Makes sense. I've done a pass adding them in both for the CHANGELOG and migration guide document. |
2834230
to
ea07f2c
Compare
@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 :-) |
There was a problem hiding this 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
|
Thanks for finishing this up djc 🚀 |
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.