Trouble with uncommitted changes in Cargo.lock with release-plz update

[sdwilsh]

Bug description

In a newly setup configuration, CI and release-plz update fails with:

Error: failed to determine next versions

Caused by:
    the working directory of this project has uncommitted changes. Please commit or stash these changes:
    ["Cargo.lock"]

I'm fairly new to Rust, so it's very possible I'm just doing it wrong, but I get no changes to Cargo.lock when I run cargo update, so I'm not sure why Cargo.lock is becoming dirty when release-plz runs. The temporary directory that release-plz clones into gets deleted, which makes it hard to debug what the changes might be as well (having a flag to let it hang around might be a feature request I can file if there is interest).

• Would you like to work on a fix? yes, even if it's to improve the docs to make whatever mistake I might have made more clear

To Reproduce

Steps to reproduce the behavior:

1. git clone https://github.com/sdwilsh/jellyfin-remote-proxy.git
2. cd jellyfin-remote-proxy
3. release-plz update

Expected behavior

The CI workflow and release-plz update runs successfully.

Environment

• OS: Ubuntu 22.04
• release-plz version: 0.3.45

Additional context

My workflow is copied verbatim from the docs, with a version selector added there, and you can see this failing in CI as well here.

[MarcoIeni]

The issue is that your Cargo.lock is committed, but it is also in .gitignore.
I have seen many users do this mistake.
If you want to open a PR to add this check here (just before the if) it would be awesome!

You should check if Cargo.lock is present and if it is in the .gitignore file.
You can find the path of the Cargo.lock by using the input.local_manifest field. I.e. you just need to change the file extension: Cargo.toml -> Cargo.lock.
You could also add an integration test for this. You can take inspiration from:

• release-plz/crates/release_plz/tests/all/release.rs

  Line 28 in e50dc2b

  async fn release_plz_releases_a_new_project_with_custom_release_name() {

• release-plz/crates/release_plz/tests/all/changelog.rs

  Line 5 in e50dc2b

  async fn release_plz_adds_changelog_on_new_project() {

[sdwilsh]

I have seen many users do this mistake.

That's probably because it's what cargo generated, and I didn't read the comment where it says you need to remove it if it's a binary!

I'll keep this open to add better messaging per your suggestion.