[cargo-smart-release]: `cargo publish` fails due to dirty files which wouldn't be included

[Byron]

See this comment for details: rust-lang/cargo#9478 (comment).

If it becomes a cargo issue we can track it here.

In the mean time, one can delete the generated files in question .

Tasks

• make the issue reproducible and file an issue, PR (see this comment for more information
• maybe even provide a fix

[Byron]

Didn't notice this in quite some time though, maybe something was fixed?

[MingweiSamuel]

This happens when my_new_crate first tries to be published but CHANGELOG.md does not exist yet in git

[Byron]

Thanks for sharing! Maybe that means it's assuming CHANGELOG.md is tracked already, and can't commit it if it is not?

[MingweiSamuel]

Yeah here is the log, it creates the CHANGELOG.md but doesn't include it in the commit, so cargo publish fails as in the title of this issue

full log

[INFO ] Updating crates-io index
[WARN ] Refused to publish 'dfir_lang' as as it didn't change.
[WARN ] Refused to publish 'dfir_macro' as as it didn't change.
[INFO ] Will not publish or alter 6 dependent crates: unchanged = 'hydro_build_utils', 'dfir_lang', 'dfir_macro', 'example_test', 'variadics', 'include_mdtests'
[INFO ] Manifest version of dependent package 'sinktools' at 0.0.1 is sufficient, creating a new release 🎉, ignoring computed version 0.0.2
[INFO ] Manifest version of dependent package 'lattices_macro' at 0.5.11 is sufficient to succeed latest released version 0.5.10, ignoring computed version 0.5.12
[INFO ] Manifest version of dependent package 'variadics_macro' at 0.6.2 is sufficient to succeed latest released version 0.6.1, ignoring computed version 0.6.3
[INFO ] Manifest version of dependent package 'lattices' at 0.6.2 is sufficient to succeed latest released version 0.6.1, ignoring computed version 0.6.3
[INFO ] Manifest version of dependent package 'copy_span' at 0.1.0 is sufficient, creating a new release 🎉, ignoring computed version 0.1.1
[INFO ] Will adjust version constraints in manifests of 3 packages as direct dependencies are changing: hydro_test, hydro_test_template, website_playground
[INFO ] Will modify existing changelog for 'sinktools'.
[TRACE] Cannot handle End(Item)
[TRACE] Cannot handle Start(Item)
[TRACE] Cannot handle Text(Borrowed(" use round-robin polling for "))
[TRACE] Cannot handle Code(Borrowed("MergeSource"))
[TRACE] Cannot handle Text(Borrowed(" to ensure fairness"))
[TRACE] Cannot handle End(Item)
[TRACE] Cannot handle Start(Item)
[TRACE] Cannot handle Text(Borrowed(" make polling fair with round-robin"))
[TRACE] Cannot handle End(Item)
[TRACE] Cannot handle End(List(None))
[INFO ] Will modify existing changelog for 'hydro_deploy_integration'.
[INFO ] Will modify existing changelog for 'lattices_macro'.
[INFO ] Will modify existing changelog for 'variadics_macro'.
[TRACE] Cannot handle End(Item)
[TRACE] Cannot handle Start(Item)
[TRACE] Cannot handle Start(Paragraph)
[TRACE] Cannot handle Code(Borrowed("Min<T>"))
[TRACE] Cannot handle Text(Borrowed(": T is not a lattice"))
[TRACE] Cannot handle End(Paragraph)
[TRACE] Cannot handle End(Item)
[TRACE] Cannot handle Start(Item)
[TRACE] Cannot handle Start(Paragraph)
[TRACE] Cannot handle Code(Borrowed("set_union<T>"))
[TRACE] Cannot handle Text(Borrowed(": is not a lattice"))
[TRACE] Cannot handle End(Paragraph)
[TRACE] Cannot handle End(Item)
[TRACE] Cannot handle Start(Item)
[TRACE] Cannot handle Start(Paragraph)
[TRACE] Cannot handle Text(Borrowed("map_union - not safe to expose map"))
[TRACE] Cannot handle End(Paragraph)
[TRACE] Cannot handle End(Item)
[TRACE] Cannot handle Start(Item)
[TRACE] Cannot handle Start(Paragraph)
   Compiling url v2.5.7
   Compiling tokio v1.47.1
   Compiling ref-cast-impl v1.0.24
   Compiling clap_derive v4.5.47
   Compiling log v0.4.28
   Compiling webbrowser v1.0.5
   Compiling futures-executor v0.3.31
   Compiling ref-cast v1.0.24
   Compiling variadics_macro v0.6.2
   Compiling clap v4.5.48
   Compiling tracing-attributes v0.1.30
   Compiling dfir_rs v0.15.0 (/home/runner/work/hydro/hydro/target/package/dfir_rs-0.15.0)
   Compiling dfir_macro v0.15.0
   Compiling tracing-core v0.1.34
   Compiling data-encoding v2.9.0
   Compiling tracing v0.1.41
   Compiling tokio-stream v0.1.17
   Compiling tokio-util v0.7.16
   Compiling futures v0.3.31
   Compiling sinktools v0.0.1
   Compiling bincode v1.3.3
   Compiling web-time v1.1.0
   Compiling rustc-hash v1.1.0
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 26.84s
   Uploading dfir_rs v0.15.0 (/home/runner/work/hydro/hydro/dfir_rs)
    Uploaded dfir_rs v0.15.0 to registry `crates-io`
note: waiting for dfir_rs v0.15.0 to be available at registry `crates-io`.
You may press ctrl-c to skip waiting; the crate should be available shortly.
   Published dfir_rs v0.15.0 at registry `crates-io`
[INFO ] Created tag object refs/tags/dfir_rs-v0.15.0 with release notes.
[INFO ] Waiting for 'dfir_rs v0.15.0' to arrive in index…
[TRACE] Updating crates index…
[INFO ] attempt 1
[TRACE] Updating crates index…
[TRACE] Will run "cargo" "publish" "--manifest-path" "/home/runner/work/hydro/hydro/copy_span/Cargo.toml" "--package" "copy_span"
    Updating crates.io index
error: 1 files in the working directory contain changes that were not yet committed into git:

copy_span/CHANGELOG.md

to proceed despite this and include the uncommitted changes, pass the `--allow-dirty` flag
[WARN ] 'cargo publish' run 1 failed but we retry up to 3 times to rule out flakiness
[TRACE] Will run "cargo" "publish" "--manifest-path" "/home/runner/work/hydro/hydro/copy_span/Cargo.toml" "--package" "copy_span"
    Updating crates.io index
error: 1 files in the working directory contain changes that were not yet committed into git:

copy_span/CHANGELOG.md

to proceed despite this and include the uncommitted changes, pass the `--allow-dirty` flag
[WARN ] 'cargo publish' run 2 failed but we retry up to 3 times to rule out flakiness
[TRACE] Will run "cargo" "publish" "--manifest-path" "/home/runner/work/hydro/hydro/copy_span/Cargo.toml" "--package" "copy_span"
    Updating crates.io index
error: 1 files in the working directory contain changes that were not yet committed into git:

copy_span/CHANGELOG.md

to proceed despite this and include the uncommitted changes, pass the `--allow-dirty` flag
[TRACE] Will run "git" "push" "origin" "HEAD" "refs/tags/sinktools-v0.0.1" "refs/tags/hydro_deploy_integration-v0.15.0" "refs/tags/lattices_macro-v0.5.11" "refs/tags/variadics_macro-v0.6.2" "refs/tags/lattices-v0.6.2" "refs/tags/multiplatform_test-v0.6.0" "refs/tags/dfir_rs-v0.15.0"
remote: Bypassed rule violations for refs/heads/main:        
remote: 
remote: - Changes must be made through a pull request.        
remote: 
remote: - 6 of 6 required status checks are expected.        
remote: 
To https://github.com/hydro-project/hydro
   79253439ba..ac88df1e98  HEAD -> main
 * [new tag]               sinktools-v0.0.1 -> sinktools-v0.0.1
 * [new tag]               hydro_deploy_integration-v0.15.0 -> hydro_deploy_integration-v0.15.0
 * [new tag]               lattices_macro-v0.5.11 -> lattices_macro-v0.5.11
 * [new tag]               variadics_macro-v0.6.2 -> variadics_macro-v0.6.2
 * [new tag]               lattices-v0.6.2 -> lattices-v0.6.2
 * [new tag]               multiplatform_test-v0.6.0 -> multiplatform_test-v0.6.0
 * [new tag]               dfir_rs-v0.15.0 -> dfir_rs-v0.15.0
[TRACE] Will run "gh" "release" "create" "sinktools-v0.0.1" "--title" "sinktools v0.0.1" "--notes" "### Bug Fixes\n\n - miss…" [note truncated]
https://github.com/hydro-project/hydro/releases/tag/sinktools-v0.0.1
[TRACE] Will run "gh" "release" "create" "hydro_deploy_integration-v0.15.0" "--title" "hydro_deploy_integration v0.15.0" "--notes" "### New Features\n\n - a…" [note truncated]
https://github.com/hydro-project/hydro/releases/tag/hydro_deploy_integration-v0.15.0
[TRACE] Will run "gh" "release" "create" "lattices_macro-v0.5.11" "--title" "lattices_macro v0.5.11" "--notes" "### Bug Fixes\n\n - refa…" [note truncated]
https://github.com/hydro-project/hydro/releases/tag/lattices_macro-v0.5.11
[TRACE] Will run "gh" "release" "create" "variadics_macro-v0.6.2" "--title" "variadics_macro v0.6.2" "--notes" "### Bug Fixes\n\n - refa…" [note truncated]
https://github.com/hydro-project/hydro/releases/tag/variadics_macro-v0.6.2
[TRACE] Will run "gh" "release" "create" "lattices-v0.6.2" "--title" "lattices v0.6.2" "--notes" "### Chore\n\n - <csr-id-…" [note truncated]
https://github.com/hydro-project/hydro/releases/tag/lattices-v0.6.2
[TRACE] Will run "gh" "release" "create" "multiplatform_test-v0.6.0" "--title" "multiplatform_test v0.6.0" "--notes" "### Chore\n\n - <csr-id-…" [note truncated]
https://github.com/hydro-project/hydro/releases/tag/multiplatform_test-v0.6.0
[TRACE] Will run "gh" "release" "create" "dfir_rs-v0.15.0" "--title" "dfir_rs v0.15.0" "--notes" "### Chore\n\n - <csr-id-…" [note truncated]
https://github.com/hydro-project/hydro/releases/tag/dfir_rs-v0.15.0
Error: Could not successfully execute 'cargo publish'.
Error: Process completed with exit code 1.

[Byron]

The issue we discussed @MingweiSamuel will be fixed with #92 .

For completeness, let me state that this issue is about something else, albeit related. It's that cargo publish sometimes sees untracked files which are actually ignored, typically when they are within an ignored Git repository.