Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't commit excluded files #721

Open
1 of 4 tasks
MarcoIeni opened this issue Apr 23, 2023 · 4 comments · Fixed by #1089
Open
1 of 4 tasks

Don't commit excluded files #721

MarcoIeni opened this issue Apr 23, 2023 · 4 comments · Fixed by #1089
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed priority:low This can wait

Comments

@MarcoIeni
Copy link
Owner

MarcoIeni commented Apr 23, 2023

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

  • 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 MarcoIeni added the enhancement New feature or request label Apr 23, 2023
@MarcoIeni MarcoIeni added good first issue Good for newcomers priority:low This can wait and removed good first issue Good for newcomers labels Apr 23, 2023
@MarcoIeni
Copy link
Owner Author

MarcoIeni commented Aug 2, 2023

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.

@lutaok
Copy link
Contributor

lutaok commented Nov 25, 2023

Hi!
I will gladly take on this issue!

@MarcoIeni
Copy link
Owner Author

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 👍

@zvolin
Copy link
Contributor

zvolin commented Jan 10, 2024

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

@MarcoIeni MarcoIeni added help wanted Extra attention is needed good first issue Good for newcomers labels Feb 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed priority:low This can wait
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants