Add more standard ignored files for Julia #2992
Conversation
In particular, this adds documentation build artifacts generated by Documenter.jl as well as Manifest.toml, which can appear in docs/, in test/, or at the top level.
|
Only question I have is about this bit:
Is the community consensus that lock files shouldn't be committed? My experiences with other ecosystems (Node/Yarn and Rust being the most recent) is that the lockfile is good to commit to ensure contributors are using the same version of dependencies (where the tooling supports some sort of range syntax). Any links to discussions about that? |
|
Well, it depends on the purpose of the repository. Currently all of the items in this example .gitignore are relevant to Julia packages. For Julia packages, committing the Manifest file causes big headaches for running CI, since when a dependent package updates to fix a bug, it's not reflected in CI. For Julia-based projects, the Manifest should be committed, as you want a static environment. Since this example .gitignore is currently targeted toward packages, I've opted to include the Manifest file here. Unfortunately I don't have a canonical reference for discussions on this topic, but I can say that I am a developer of Julia itself and have been lightly involved in the development of the package manager. We should probably add some information about this to Julia's documentation. |
This is the extra bit of context I needed. Would you be able to add a comment before the rule to indicate:
|
|
Yes, absolutely. |
Also add a few more build artifacts from BinaryProvider/BinDeps.
|
Does this next commit provide sufficient information, or is there anything else you think would be valuable to mention? |
|
Thanks for suggesting they be there! I think that will be helpful for people wondering what these things are, and I wouldn't have thought to comment on them myself. |
* Add more standard ignored files for Julia In particular, this adds documentation build artifacts generated by Documenter.jl as well as Manifest.toml, which can appear in docs/, in test/, or at the top level. * Clarify the intent of each ignored item Also add a few more build artifacts from BinaryProvider/BinDeps.
* Add more standard ignored files for Julia In particular, this adds documentation build artifacts generated by Documenter.jl as well as Manifest.toml, which can appear in docs/, in test/, or at the top level. * Clarify the intent of each ignored item Also add a few more build artifacts from BinaryProvider/BinDeps.
Reasons for making this change:
The Julia template here hasn't been updated in a while, and since its last update, new ignorable files have entered the Julia project workflow, including:
Links to documentation supporting these rule changes:
.gitignorefiles