Mark Julia package manifests (Manifest.toml) as generated#7960
Merged
Conversation
Julia's package manager produces a Manifest.toml file when the active project file is called Project.toml, and it produces a JuliaManifest.toml if the project file is called JuliaProject.toml. Manifests resolved with different Julia versions can live alongside one another, differentiated by a versioned suffix. Such files are not produced automatically; a generated manifest must be manually renamed to include a version suffix. In that case, it is still a generated file, despite the manual intervention. The first line of these files is typically: ``` ``` However, using the filename is much simpler than checking for this text.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Resolved package environments for the Julia language are generated by the package manager and captured in TOML files. They can be large and distract from more meaningful changes when reviewing PRs.
Julia's package manager produces a Manifest.toml file when the active project file is called Project.toml, and it produces a JuliaManifest.toml if the project file is called JuliaProject.toml. Manifests resolved with different Julia versions can live alongside one another, differentiated by a versioned suffix. Such files are not produced automatically; a generated manifest must be manually renamed to include a version suffix. In that case, it is still a generated file, despite the manual intervention.
The first line of these files is typically:
# This file is machine-generated - editing it directly is not advisedHowever, using the filename is much simpler than checking for this text. (Also note that these files would almost certainly never be written by hand.)
Checklist: