Skip to content

Commit a35ad01

Browse files
committed
Mark ProjectManifestSnapshot, take_project_manifest_snapshot as public API
1 parent 40631be commit a35ad01

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name = "GracefulPkg"
22
uuid = "828d9ff0-206c-6161-646e-6576656f7244"
33
license = "MIT"
44
authors = ["Fons van der Plas <[email protected]>"]
5-
version = "2.2.2"
5+
version = "2.3.0"
66

77
[deps]
88
Compat = "34da2185-b29b-5c13-b0c7-acf172513d20"

src/project manifest snapshot.jl

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,23 @@
1+
using Compat
2+
3+
@compat public ProjectManifestSnapshot, take_project_manifest_snapshot
14

25
"""
3-
The contents of the Project.toml and Manifest.toml files at the time of recording.
6+
The contents of the Project.toml and Manifest.toml files at the time of recording. `nothing` if a file does not exist.
47
"""
58
Base.@kwdef struct ProjectManifestSnapshot
69
project::Union{Nothing,String} = nothing
710
manifest::Union{Nothing,String} = nothing
811
end
912

13+
14+
"""
15+
```julia
16+
take_project_manifest_snapshot(env_dir::String)::ProjectManifestSnapshot
17+
```
18+
19+
Take a snapshot of the Project.toml and Manifest.toml files in the given environment directory. Returns a [`ProjectManifestSnapshot`](@ref) object.
20+
"""
1021
function take_project_manifest_snapshot(env_dir::String)
1122
p = joinpath(env_dir, "Project.toml")
1223
m = joinpath(env_dir, "Manifest.toml")

0 commit comments

Comments
 (0)