sstadick / cargo-bundle-licenses

Generate a THIRDPARTY file with all licenses in a cargo project.
Apache License 2.0
86 stars 6 forks source link

Need better developer experience when Dependabot version updates are involved #27

Open jwodder opened 10 months ago

jwodder commented 10 months ago

I have a project that uses cargo-bundle-licenses to bundle the licenses for all of its third-party dependencies, and this same project has Dependabot version updates enabled for all dependencies (both direct and indirect). As a result, every Monday, a pull request is automatically created in the project repository updating the versions of some number of dependencies, usually only touching the lockfile. Per cargo-bundle-licenses' recommendation, I have also configured GitHub Actions to run cargo bundle-licenses --check-previous -o CI.toml -p THIRDPARTY.toml on every push & PR.

As a result, whenever Dependabot opens one of its PRs, the CI fails because the changes to dependency versions made the --check-previous command exit nonzero. On the one hand, this is good, as it reminds me to update the THIRDPARTY.toml file. On the other hand, this is annoying, as I have to manually update the file locally despite an up-to-date license bundle having been generated in CI.

Here's my dream for how this should work instead:

I'm not asking or requiring you to help me fulfill this dream, but I'd be nice if you did. I just want you to be aware that the developer experience around keeping my THIRDPARTY.toml up-to-date could stand to be improved.

sstadick commented 10 months ago

These are great points. I've also found the workflow with cargo bundle-licenses to be lacking, but haven't been working on anything that uses it in a while. That may be changing sometime soon though. In the meantime I continue to welcome all PRs and really appreciate the work you've already put in here.