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

Exclude Directory.Build.rsp from VisualStudio.gitignore template #4493

Merged
merged 1 commit into from
Oct 17, 2024

Conversation

MattKotsenas
Copy link
Contributor

@MattKotsenas MattKotsenas commented Aug 15, 2024

Reasons for making this change:

Directory.Build.rsp is a documented file that allows setting default arguments to command line builds. However, the .gitignore template ignores all *.rsp files. which causes confusion:

  1. Devs write an .rsp file and if they aren't being attentive forget to commit it
  2. Adding it to git requires git add --force, which some devs mistake for a destructive or not-recommended action

Thus, explicitly allow the Directory.Build.rsp file.

Links to documentation supporting these rule changes:

`Directory.Build.rsp` is a [documented file][1] that allows setting default arguments to command line builds. However, our .gitignore template ignores _all_ `*.rsp` files. which causes confusion:

1. Devs write an .rsp file and if they aren't being attentive forget to commit it
2. Adding it to git requires `git add --force`, which some devs mistake for a destructive or not-recommended action

Thus, explicitly allow the `Directory.Build.rsp` file.

[1]: https://learn.microsoft.com/en-us/visualstudio/msbuild/msbuild-response-files?view=vs-2022#directorybuildrsp
@MattKotsenas
Copy link
Contributor Author

/cc @wirecat, @bdougie

Do either of you know who can review here? Any help is greatly appreciated. If you have any questions or concerns, please let me know. Thanks!

@MattKotsenas
Copy link
Contributor Author

@dooleydevin, sorry for the bother, but at the most recently active person in this repo, would you mind letting me know what I can do to push this change forward? Any help is greatly appreciated. Thanks!

@dooleydevin dooleydevin merged commit 76739a3 into github:main Oct 17, 2024
@dooleydevin
Copy link
Collaborator

@MattKotsenas this looks like a good change to me based on this quote from the docs:

This file can be helpful in a source code repository to provide default arguments during command-line builds. It can also be used to specify the command-line arguments of hosted builds.

Merged!

@MattKotsenas MattKotsenas deleted the patch-1 branch October 17, 2024 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants