rust-lang / rust-lang/rustdoc-types
Automate updating/publishing
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 44
- Forks
- 20
- PR merge metrics
- No merged PRs in 30d
Description
Part 1: Automatically generate changes with GHA
- Detect changes in
src/rustdoc-json-types - Decide if this is a major or minor version (
FORMAT_VERSIONshould be a decent proxy, but may not be true if JSON format doesn't change but rust does) - Run
./update.sh - Update Cargo.toml
- Update CHANGELOG.md
- Create PR.
Part 2: Automaticly publish to Crates.io
- Detect new version has been merged
- Publish to crates.io
- Do this in a way giving a way with minimal perms.
Overall, I don't think I wan't to automaticly publish on upstream changes, but it would be nice for it to be more automated
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing workflow setup and the update path around src/rustdoc-json-types and ./update.sh. Trace how Cargo.toml and CHANGELOG.md are currently updated, then define automation for change detection, versioning, PR creation, and crates.io publishing with minimal permissions. Done means the required workflow steps run reliably without publishing on unrelated upstream changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, rust
- Domain
- ci-cd, release
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100