Ignore Julia environment and coverage artifacts - #13
Draft
smartalecH wants to merge 1 commit into
Draft
Conversation
Running Pkg.instantiate() in src/julia/SSP or examples/julia writes a Manifest.toml, which should not be tracked for a package. Also ignore the coverage and allocation files that `julia --code-coverage` / `--track-allocation` leave next to the sources.
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
1 participant
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.
Stacked on #12 (base branch is
python/lengthscale-constraints), which is itself stacked on #11.Running
Pkg.instantiate()insrc/julia/SSP(orexamples/julia) writes aManifest.tomlthat currently shows up as untracked — easy to commit by accident, and a resolved manifest shouldn't be tracked for a package that supports a range of dependency versions. This adds a Julia section to.gitignore:Manifest.tomlandManifest-v*.toml(Julia writes the versioned form for somejuliaversions);*.jl.cov,*.jl.*.cov,*.jl.mem, left behind byjulia --code-coverageand--track-allocation.Verified by re-running
Pkg.instantiate()insrc/julia/SSP: the regeneratedManifest.tomlno longer appears ingit status, andgit check-ignore -vattributes it to the new rule.I deliberately left the PNGs that the examples write into the working directory (
projection.png,constraint_sweep.png, ...) out of this — a blanket*.pngrule would silently swallow figures we may later want to commit for the docs. Happy to add explicit names if you'd rather.