From d52fc42358a3bb8c3b470a84b89eea42d76f26ae Mon Sep 17 00:00:00 2001 From: Pascal Aellig Date: Tue, 27 Feb 2024 17:30:33 +0100 Subject: [PATCH 1/6] `comment = true` --- .codecov.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.codecov.yaml b/.codecov.yaml index 6aa5b2cd..7f251f83 100644 --- a/.codecov.yaml +++ b/.codecov.yaml @@ -7,4 +7,4 @@ coverage: default: informational: true changes: false -comment: false +comment: true From bbee00f0b407ada3048e0e1b3e282ebce04769e7 Mon Sep 17 00:00:00 2001 From: Pascal Aellig Date: Tue, 27 Feb 2024 17:42:00 +0100 Subject: [PATCH 2/6] update License --- LICENSE.md | 2 +- docs/make.jl | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index 89bc148a..e36eba39 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2021 Boris Kaus, Marcel Thielmann and Authors (see AUTHORS.md) +Copyright (c) 2021 Boris Kaus, Marcel Thielmann and Authors (see [AUTHORS.md](AUTHORS.md)) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/docs/make.jl b/docs/make.jl index bd96f315..da8bee51 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -46,7 +46,6 @@ open(joinpath(@__DIR__, "src", "man", "contributing.md"), "w") do io for line in eachline(joinpath(dirname(@__DIR__), "CONTRIBUTING.md")) line = replace(line, "[LICENSE.md](LICENSE.md)" => "[License](@ref)") line = replace(line, "[AUTHORS.md](AUTHORS.md)" => "[Authors](@ref)") - # line = replace(line, "[AUTHORS.md](AUTHORS.md)" => "[Authors](@ref)") println(io, "> ", line) end end From be42bd83a56de725f04ec514fc249cec204ae2dd Mon Sep 17 00:00:00 2001 From: Pascal Aellig Date: Tue, 27 Feb 2024 19:22:10 +0100 Subject: [PATCH 3/6] add license; fix `@ref` --- docs/make.jl | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/make.jl b/docs/make.jl index da8bee51..428bdab8 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -93,6 +93,7 @@ makedocs(; "Authors" => "man/authors.md", "Contributing" => "man/contributing.md", "Code of Conduct" => "man/code_of_conduct.md" + "License" => "man/license.md", ], ) From 7598df0d6424eb61966767460958adb2bbaf3851 Mon Sep 17 00:00:00 2001 From: Pascal Aellig Date: Wed, 28 Feb 2024 08:36:28 +0100 Subject: [PATCH 4/6] fix typo --- docs/make.jl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/make.jl b/docs/make.jl index 428bdab8..5bcce748 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -92,7 +92,7 @@ makedocs(; "List of functions" => "man/listfunctions.md", "Authors" => "man/authors.md", "Contributing" => "man/contributing.md", - "Code of Conduct" => "man/code_of_conduct.md" + "Code of Conduct" => "man/code_of_conduct.md", "License" => "man/license.md", ], ) From f62afdca2bd0195fd4d94d0e06606ffabbf41b02 Mon Sep 17 00:00:00 2001 From: Pascal Aellig Date: Wed, 28 Feb 2024 08:38:12 +0100 Subject: [PATCH 5/6] add missing md to man --- docs/make.jl | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/make.jl b/docs/make.jl index 5bcce748..9bc6115d 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -14,6 +14,9 @@ write(joinpath(@__DIR__, "src", "man", "authors.md"), authors_text) #Contributing contributing = read(joinpath(GMG_root_dir, "CONTRIBUTING.md"), String) write(joinpath(@__DIR__, "src", "man", "contributing.md"), contributing) +#License +License = read(joinpath(GMG_root_dir, "LICENSE.md"), String) +write(joinpath(@__DIR__, "src", "man", "license.md"), license) # Copy some files from the repository root directory to the docs and modify them # as necessary From fd5a3d3e142a9d60cea58a7abc7b262633f4ffcb Mon Sep 17 00:00:00 2001 From: Pascal Aellig Date: Wed, 28 Feb 2024 09:38:07 +0100 Subject: [PATCH 6/6] test fix --- AUTHORS.md | 3 ++- CONTRIBUTING.md | 3 +-- docs/make.jl | 28 ++++++++++++++++++++-------- 3 files changed, 23 insertions(+), 11 deletions(-) diff --git a/AUTHORS.md b/AUTHORS.md index e162fdf5..4df1c401 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -4,7 +4,7 @@ GeophysicalModelGenerator.jl's development is coordinated by a group of *princip who are also its main contributors and who can be contacted in case of questions about GeophysicalModelGenerator.jl. In addition, there are *contributors* who have provided substantial additions or modifications. Together, these two groups form -"The GeophysicalModelGenerator.jl Authors" as mentioned in the [LICENSE.md](LICENSE.md) file. +"The GeophysicalModelGenerator.jl Authors". ## Principal Developers * [Boris Kaus](https://www.geosciences.uni-mainz.de/geophysics-and-geodynamics/team/univ-prof-dr-boris-kaus/), @@ -20,6 +20,7 @@ are listed in alphabetical order: * Pascal Aellig * Luca De Siena * Andrea Piccolo +* Hendrik Rachona * Christian Schuler * Arne Spang * Tatjana Weiler diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2d3d08cc..57e5eb64 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,8 +6,7 @@ as pull requests) any time. For planned larger contributions, it is often beneficial to get in contact with one of the principal developers first (see [AUTHORS.md](AUTHORS.md)). -GeophysicalModelGenerator.jl and its contributions are licensed under the MIT license (see -[LICENSE.md](LICENSE.md)). As a contributor, you certify that all your +GeophysicalModelGenerator.jl and its contributions are licensed under the MIT license. As a contributor, you certify that all your contributions are in conformance with the *Developer Certificate of Origin (Version 1.1)*, which is reproduced below. diff --git a/docs/make.jl b/docs/make.jl index 9bc6115d..5174d41f 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -7,20 +7,32 @@ using Documenter # Get GeophysicalModelGenerator.jl root directory GMG_root_dir = dirname(@__DIR__) +license = read(joinpath(GMG_root_dir, "LICENSE.md"), String) +write(joinpath(@__DIR__, "src", "man", "license.md"), license) # Copy list of authors to not need to synchronize it manually authors_text = read(joinpath(GMG_root_dir, "AUTHORS.md"), String) -authors_text = replace(authors_text, "in the [LICENSE.md](LICENSE.md) file" => "under [License](@ref)") +# authors_text = replace(authors_text, "in the [LICENSE.md](LICENSE.md) file" => "under [License](@ref)") write(joinpath(@__DIR__, "src", "man", "authors.md"), authors_text) -#Contributing -contributing = read(joinpath(GMG_root_dir, "CONTRIBUTING.md"), String) -write(joinpath(@__DIR__, "src", "man", "contributing.md"), contributing) -#License -License = read(joinpath(GMG_root_dir, "LICENSE.md"), String) -write(joinpath(@__DIR__, "src", "man", "license.md"), license) # Copy some files from the repository root directory to the docs and modify them # as necessary # Based on: https://github.com/ranocha/SummationByPartsOperators.jl/blob/0206a74140d5c6eb9921ca5021cb7bf2da1a306d/docs/make.jl#L27-L41 +open(joinpath(@__DIR__, "src", "man", "license.md"), "w") do io + # Point to source license file + println(io, """ + ```@meta + EditURL = "https://github.com/JuliaGeodynamics/GeophysicalModelGenerator.jl/blob/main/LICENSE.md" + ``` + """) + # Write the modified contents + println(io, "# [License](@id license)") + println(io, "") + for line in eachline(joinpath(dirname(@__DIR__), "LICENSE.md")) + line = replace(line, "[AUTHORS.md](AUTHORS.md)" => "[Authors](@ref)") + println(io, "> ", line) + end +end + open(joinpath(@__DIR__, "src", "man", "code_of_conduct.md"), "w") do io # Point to source license file println(io, """ @@ -96,7 +108,7 @@ makedocs(; "Authors" => "man/authors.md", "Contributing" => "man/contributing.md", "Code of Conduct" => "man/code_of_conduct.md", - "License" => "man/license.md", + "License" => "man/license.md" ], )