Skip to content

Commit

Permalink
Add a Documenter{GitLabCI} reference test suite
Browse files Browse the repository at this point in the history
Since the one in WackyOptions is now GitHubActions to test `deploybranch`.
  • Loading branch information
christopher-dG committed Dec 7, 2020
1 parent 659026c commit 73085a5
Show file tree
Hide file tree
Showing 14 changed files with 270 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: CompatHelper
on:
schedule:
- cron: 0 0 * * *
workflow_dispatch:
jobs:
CompatHelper:
runs-on: ubuntu-latest
steps:
- name: Pkg.add("CompatHelper")
run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
- name: CompatHelper.main()
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
run: julia -e 'using CompatHelper; CompatHelper.main()'
15 changes: 15 additions & 0 deletions test/fixtures/DocumenterGitLabCI/.github/workflows/TagBot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: TagBot
on:
issue_comment:
types:
- created
workflow_dispatch:
jobs:
TagBot:
if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
runs-on: ubuntu-latest
steps:
- uses: JuliaRegistries/TagBot@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
ssh: ${{ secrets.DOCUMENTER_KEY }}
5 changes: 5 additions & 0 deletions test/fixtures/DocumenterGitLabCI/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
*.jl.*.cov
*.jl.cov
*.jl.mem
/Manifest.toml
/docs/build/
48 changes: 48 additions & 0 deletions test/fixtures/DocumenterGitLabCI/.gitlab-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
.script:
script:
- |
julia --project=@. -e '
using Pkg
Pkg.build()
Pkg.test(coverage=true)'
.coverage:
coverage: /Test coverage (\d+\.\d+%)/
after_script:
- |
julia -e '
using Pkg
Pkg.add("Coverage")
using Coverage
c, t = get_summary(process_folder())
using Printf
@printf "Test coverage %.2f%%\n" 100c / t'
Julia 1.0:
image: julia:1.0
extends:
- .script
- .coverage
Julia 1.5:
image: julia:1.5
extends:
- .script
- .coverage
pages:
image: julia:1.0
stage: deploy
script:
- |
julia --project=docs -e '
using Pkg
Pkg.develop(PackageSpec(path=pwd()))
Pkg.instantiate()
using Documenter: doctest
using DocumenterGitLabCI
doctest(DocumenterGitLabCI)
include("docs/make.jl")'
- mkdir -p public
- mv docs/build public/dev
artifacts:
paths:
- public
only:
- main
21 changes: 21 additions & 0 deletions test/fixtures/DocumenterGitLabCI/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2019 tester

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
13 changes: 13 additions & 0 deletions test/fixtures/DocumenterGitLabCI/Project.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name = "DocumenterGitLabCI"
uuid = "5b7e9947-ddc0-4b3f-9b55-0d8042f74170"
authors = ["tester"]
version = "0.1.0"

[compat]
julia = "1"

[extras]
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

[targets]
test = ["Test"]
5 changes: 5 additions & 0 deletions test/fixtures/DocumenterGitLabCI/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# DocumenterGitLabCI

[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://tester.gitlab.io/DocumenterGitLabCI.jl/dev)
[![Build Status](https://github.com/tester/DocumenterGitLabCI.jl/badges/main/pipeline.svg)](https://github.com/tester/DocumenterGitLabCI.jl/pipelines)
[![Coverage](https://github.com/tester/DocumenterGitLabCI.jl/badges/main/coverage.svg)](https://github.com/tester/DocumenterGitLabCI.jl/commits/main)
98 changes: 98 additions & 0 deletions test/fixtures/DocumenterGitLabCI/docs/Manifest.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
# This file is machine-generated - editing it directly is not advised

[[Base64]]
uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"

[[Dates]]
deps = ["Printf"]
uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"

[[Distributed]]
deps = ["Random", "Serialization", "Sockets"]
uuid = "8ba89e20-285c-5b6f-9357-94700520ee1b"

[[DocStringExtensions]]
deps = ["LibGit2", "Markdown", "Pkg", "Test"]
git-tree-sha1 = "88bb0edb352b16608036faadcc071adda068582a"
uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
version = "0.8.1"

[[Documenter]]
deps = ["Base64", "Dates", "DocStringExtensions", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"]
git-tree-sha1 = "0be9bf63e854a2408c2ecd3c600d68d4d87d8a73"
uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
version = "0.24.2"

[[DocumenterGitLabCI]]
path = ".."
uuid = "5b7e9947-ddc0-4b3f-9b55-0d8042f74170"
version = "0.1.0"

[[InteractiveUtils]]
deps = ["Markdown"]
uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"

[[JSON]]
deps = ["Dates", "Mmap", "Parsers", "Unicode"]
git-tree-sha1 = "b34d7cef7b337321e97d22242c3c2b91f476748e"
uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
version = "0.21.0"

[[LibGit2]]
deps = ["Printf"]
uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"

[[Libdl]]
uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb"

[[Logging]]
uuid = "56ddb016-857b-54e1-b83d-db4d58db5568"

[[Markdown]]
deps = ["Base64"]
uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"

[[Mmap]]
uuid = "a63ad114-7e13-5084-954f-fe012c677804"

[[Parsers]]
deps = ["Dates", "Test"]
git-tree-sha1 = "0139ba59ce9bc680e2925aec5b7db79065d60556"
uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
version = "0.3.10"

[[Pkg]]
deps = ["Dates", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "UUIDs"]
uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"

[[Printf]]
deps = ["Unicode"]
uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7"

[[REPL]]
deps = ["InteractiveUtils", "Markdown", "Sockets"]
uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"

[[Random]]
deps = ["Serialization"]
uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"

[[SHA]]
uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce"

[[Serialization]]
uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"

[[Sockets]]
uuid = "6462fe0b-24de-5631-8697-dd941f90decc"

[[Test]]
deps = ["Distributed", "InteractiveUtils", "Logging", "Random"]
uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

[[UUIDs]]
deps = ["Random", "SHA"]
uuid = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"

[[Unicode]]
uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"
2 changes: 2 additions & 0 deletions test/fixtures/DocumenterGitLabCI/docs/Project.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
19 changes: 19 additions & 0 deletions test/fixtures/DocumenterGitLabCI/docs/make.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
using DocumenterGitLabCI
using Documenter

DocMeta.setdocmeta!(DocumenterGitLabCI, :DocTestSetup, :(using DocumenterGitLabCI); recursive=true)

makedocs(;
modules=[DocumenterGitLabCI],
authors="tester",
repo="https://github.com/tester/DocumenterGitLabCI.jl/blob/{commit}{path}#L{line}",
sitename="DocumenterGitLabCI.jl",
format=Documenter.HTML(;
prettyurls=get(ENV, "CI", "false") == "true",
canonical="https://tester.gitlab.io/DocumenterGitLabCI.jl",
assets=String[],
),
pages=[
"Home" => "index.md",
],
)
12 changes: 12 additions & 0 deletions test/fixtures/DocumenterGitLabCI/docs/src/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
```@meta
CurrentModule = DocumenterGitLabCI
```

# DocumenterGitLabCI

```@index
```

```@autodocs
Modules = [DocumenterGitLabCI]
```
5 changes: 5 additions & 0 deletions test/fixtures/DocumenterGitLabCI/src/DocumenterGitLabCI.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module DocumenterGitLabCI

# Write your package code here.

end
6 changes: 6 additions & 0 deletions test/fixtures/DocumenterGitLabCI/test/runtests.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
using DocumenterGitLabCI
using Test

@testset "DocumenterGitLabCI.jl" begin
# Write your tests here.
end
5 changes: 5 additions & 0 deletions test/reference.jl
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,11 @@ end
])
end

@testset "Documenter (GitLabCI)" begin
test_all("DocumenterGitLabCI"; authors=USER, plugins=[
Documenter{GitLabCI}(), GitLabCI(),
])
end

@testset "Wacky options" begin
test_all("WackyOptions"; authors=USER, julia=v"1.2", host="x.com", plugins=[
Expand Down

0 comments on commit 73085a5

Please sign in to comment.