Skip to content

Conversation

@szokeasaurusrex
Copy link
Member

@szokeasaurusrex szokeasaurusrex commented Feb 3, 2026

Extract all common package items, which can be extracted, to the workspace Cargo.toml, except for the version field.

Note on version & license

We cannot extract version because it causes a parse error when generating the crate README.md files while bumping the version prior to release, as the cargo-readme tool we use to generate these files apparently cannot parse version = { workspace = true }, as it expects version to be set to a string. Similarly, cargo readme also fails if license is set with { workspace = true }

@Dav1dde, do you have any suggestions for how to get around this? I think the way forward may be to simply stop using cargo readme, as our README files are quite verbose. Instead, I would propose having a short static README for each crate, directing users interested in full docs over to our docs.rs pages. What do you think?

In any case, this should happen in a separate PR.

@Dav1dde
Copy link
Member

Dav1dde commented Feb 3, 2026

I assume it will also not accept the shorthand: <dep>.workspace = true.

There is an issue in the cargo-readme repo which links to https://crates.io/crates/cargo-rdme which apparantely works with workspace dependencies, possibly also an option?

Not familiar overall with the release process etc, but your suggestion also makes sense to me.

@szokeasaurusrex
Copy link
Member Author

szokeasaurusrex commented Feb 3, 2026

There is an issue in the cargo-readme repo which links to https://crates.io/crates/cargo-rdme which apparantely works with workspace dependencies, possibly also an option?

cargo-rdme has inferior support for intradocs links; I have already tried it out. Some links that compile as expected in cargo-readme don't work in cargo-rdme.

imho it would be simplest just to keep the README minimal and have the docs.rs page be the main source for more comprehensive documentation

@szokeasaurusrex
Copy link
Member Author

I assume it will also not accept the shorthand: <dep>.workspace = true.

I will double-check this

@Dav1dde
Copy link
Member

Dav1dde commented Feb 3, 2026

imho it would be simplest just to keep the README minimal and have the docs.rs page be the main source for more comprehensive documentation

Totally fair!

@szokeasaurusrex
Copy link
Member Author

@Dav1dde Also I just reread your comment, and noticed you were mentioning workspace dependencies. This change does not extract dependencies to the workspace yet, only the package items.

@szokeasaurusrex szokeasaurusrex force-pushed the szokeasaurusrex/package branch 2 times, most recently from f6e6081 to 44de6e8 Compare February 9, 2026 10:50
Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.

@szokeasaurusrex szokeasaurusrex force-pushed the szokeasaurusrex/package branch from 44de6e8 to 601a145 Compare February 9, 2026 10:53
@szokeasaurusrex szokeasaurusrex enabled auto-merge (squash) February 9, 2026 10:54
@szokeasaurusrex szokeasaurusrex merged commit 601a145 into master Feb 9, 2026
19 checks passed
@szokeasaurusrex szokeasaurusrex deleted the szokeasaurusrex/package branch February 9, 2026 10:57
szokeasaurusrex added a commit that referenced this pull request Feb 9, 2026
Bump the MSRV to 1.88 to allow dependency updates (see #968). I do not
think this change requires a major version bump, as our [MSRV
policy](https://github.com/getsentry/sentry-rust?tab=readme-ov-file#requirements)
states we try to support the last six months of Rust versions, and 1.88
is more than six months old.

Stacked on #969.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants