Skip to content

Dev/update version and notes#223

Open
chifflier wants to merge 10 commits intomasterfrom
dev/update-version-and-notes
Open

Dev/update version and notes#223
chifflier wants to merge 10 commits intomasterfrom
dev/update-version-and-notes

Conversation

@chifflier
Copy link
Member

Misc changes to prepare first beta release (which will be 0.19.0-beta.1):

  • Fix version number in CHANGELOG and UPGRADING files (closes UPGRADING file does not seem to apply #222)
  • Update version to 0.19.0-beta.1
  • chore(cargo): update dependencies time and thiserror
    • note that time depends on time-core which unfortunately requires rust 1.81, which explains the next commits
    • compatibility with our current MSRV is still possible by using a --precise flag with cargo update
  • Clarify MSRV policy in README
  • switch to cargo rdme, add CI checks and update links
    • this helps maintaining src/lib.rs and README.md in sync

@chifflier chifflier requested a review from cpu September 8, 2025 09:55
@chifflier
Copy link
Member Author

@cpu ping? I do not mean to hurry. I totally understand if you do not have time, just tell me :)

@cpu
Copy link
Collaborator

cpu commented Sep 15, 2025

Thanks for the ping and sorry for letting it sit without a reply! I'm a bit more over-subscribed than usual this week and probably won't have a chance to look at it until ~next. You don't have to wait for me of course if that's too long to wait.

@dns2utf8
Copy link

dns2utf8 commented Dec 5, 2025

Quick question, is the code in this PR what landed in the 0.18 release?

Thank you all

@chifflier
Copy link
Member Author

Hi @cpu,
Gentle ping for this PR review

Quick question, is the code in this PR what landed in the 0.18 release?
Yes (and more). This is mostly merging the entry for 0.18.0 in CHANGELOG.md, and then bumping version for master (next release planned is 0.19.0-beta.1)

Copy link
Collaborator

@cpu cpu left a comment

Choose a reason for hiding this comment

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

Thanks for the ping and apologies for letting this fall off my radar! Here's some initial feedback.

[![Github CI](https://github.com/rusticata/x509-parser/workflows/Continuous%20integration/badge.svg)](https://github.com/rusticata/x509-parser/actions)
[![Minimum rustc version](https://img.shields.io/badge/rustc-1.67.1+-lightgray.svg)](#rust-version-requirements)

<!-- cargo-rdme start -->
Copy link
Collaborator

Choose a reason for hiding this comment

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

Unfortunately it seems like this commit is breaking many markdown links in the rendered preview (https://github.com/rusticata/x509-parser/blob/fe005007af027b0cbf24f8a8bd8fadac204df527/README.md)

I think the link targets aren't quite right.

Copy link
Collaborator

Choose a reason for hiding this comment

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

(Would also be nice to get #230 merged)

Copy link
Member Author

Choose a reason for hiding this comment

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

This is an annoying limitation of cargo rdme: not all intradoc links are supported, for ex [`visitor`] is not replaced.
I found a workaround by giving the full path [`X509Certificate`](crate::certificate::X509Certificate) but now cargo doc is complaining that the path is redundant
If I push a commit to use this workaround, this will add warnings when running cargo doc (and cannot fix all links).

The last solution is to strip the intradoc links when generating the README.

Copy link
Member Author

Choose a reason for hiding this comment

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

About #230 , I cherry-picked the commit in this branch with a few changes to resolve the conflicts and change src/lib.rs as well as README.md.

Copy link
Collaborator

@cpu cpu Feb 12, 2026

Choose a reason for hiding this comment

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

This is an annoying limitation of cargo rdme: not all intradoc links are supported, for ex [visitor] is not replaced.

Bummer :-(

Would you be open to a more direct/dumber solution? We use a small script in rustls that slurps the header rustdoc from lib.rs and inserts it into the README at a fixed location. In CI we run the same script and then error if there's a diff to make sure we always update lib.rs and not the copy in README.md.

I don't think we've had any significant trouble/friction with this approach but it's not quite as polished as a dedicated tool like cargo rdme.

If I push a commit to use this workaround, this will add warnings when running cargo doc (and cannot fix all links).

I wonder if it's possible to silence/allow just that one warning about redundant paths. That seems preferable to allowing all warnings, or stripping links if you want to stick with cargo rdme.

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.

UPGRADING file does not seem to apply

3 participants