release-plz icon indicating copy to clipboard operation
release-plz copied to clipboard

Don't commit excluded files

Open marcoieni opened this issue 1 year ago • 4 comments

Motivations

We should honor excluded and included Cargo manifest files. Docs here.

You can list the files to include in the package with cargo package --list

Solution

  • [x] When running the diff algorithm, we should only consider the files in cargo package --list.
  • [ ] When checking if the repository is clean, ignore files not in cargo package --list.
  • [ ] git add only files in cargo package --list
  • [ ] When release-plz detects that the repository is not clean, suggest adding these files to the ignored files list in Cargo.toml. Link to the docs.

marcoieni avatar Apr 23 '23 21:04 marcoieni

This feature is handy if you don't want release-plz to open a PR for changes in every file. E.g. if you don't want release-plz to raise a PR for a change in the README.md file, you could add README.md file to the excluded files. Same for CHANGELOG.md.

marcoieni avatar Aug 02 '23 14:08 marcoieni

Hi! I will gladly take on this issue!

lutaok avatar Nov 25 '23 09:11 lutaok

First item in the list completed by #1089 🎉 This was the most important bit, but it would be nice to implement the other ones, too 👍

marcoieni avatar Nov 30 '23 22:11 marcoieni

Hey, I was wrong in my mention, our issue turned out to be the file in tree which was also matched by .gitignore rules.

zvolin avatar Jan 10 '24 16:01 zvolin