-
Notifications
You must be signed in to change notification settings - Fork 5
203 lines (203 loc) · 7.67 KB
/
ci.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
name: CI
on:
push:
branches:
- master
- dev
- 'release-*'
tags:
- '*'
pull_request:
branches:
- master
concurrency:
# Skip intermediate builds: always.
# Cancel intermediate builds: only if it is a pull request build.
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
jobs:
test:
name: Test ${{ matrix.title }}
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
include:
- title: 'Linux - Latest'
os: ubuntu-latest
version: '1'
- title: 'Windows - Latest'
os: windows-latest
version: '1'
steps:
- uses: actions/checkout@v4
- uses: julia-actions/setup-julia@v2
with:
version: ${{ matrix.version }}
- uses: julia-actions/cache@v2
- name: "Instantiate test environment"
run: julia --project=test devrepl.jl
- name: "Run tests"
shell: julia --color=yes --project=test --code-coverage="@" --depwarn="yes" --check-bounds="yes" {0}
run: |
include(joinpath(pwd(), "test", "runtests.jl"))
- uses: julia-actions/julia-processcoverage@v1
- name: "Summarize coverage"
run: julia --project=test -L devrepl.jl -e 'show_coverage()'
- uses: codecov/codecov-action@v4
with:
files: lcov.info
token: ${{ secrets.CODECOV_TOKEN }}
testoldest:
name: Test Lower Compat Bounds
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: julia-actions/setup-julia@v2
with:
version: 1.6
- uses: julia-actions/cache@v2
- name: "Instantiate test environment"
shell: julia --project=test {0}
run: |
import Pkg
println("*** Dev-Installing DocumenterCitations")
Pkg.develop(path=pwd())
println("*** Pinning minimal dependencies")
Pkg.pin([
Pkg.PackageSpec(name="AbstractTrees", version="0.4.0"),
Pkg.PackageSpec(name="Bibliography", version="0.2.15"),
Pkg.PackageSpec(name="Documenter", version="1.0.0"),
Pkg.PackageSpec(name="MarkdownAST", version="0.1.2"),
Pkg.PackageSpec(name="OrderedCollections", version="1.6.0"),
])
Pkg.precompile()
Pkg.status()
- name: "Run tests"
shell: julia --color=yes --project=test {0}
run: |
include(joinpath(pwd(), "test", "runtests.jl"))
docs:
name: Documentation
runs-on: ubuntu-latest
permissions:
contents: write
statuses: write
pages: write
steps:
- uses: actions/checkout@v4
- uses: julia-actions/setup-julia@v2
with:
version: '1'
- name: "Instantiate test environment"
run: julia --project=test devrepl.jl
- name: "Build documentation"
run: julia --project=test docs/make.jl
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
- uses: actions/upload-artifact@v3
with:
name: documenter-citations-docs
path: docs/build/
codestyle:
name: Codestyle
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: julia-actions/setup-julia@v2
with:
version: '1'
- name: Install JuliaFormatter and format
# This will use the latest version by default but you can set the version like so:
#
# julia -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter", version="0.13.0"))'
run: |
julia -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter"))'
julia -e 'using JuliaFormatter; format(["src", "docs", "test", "devrepl.jl"], verbose=true)'
- name: Format Check
shell: julia {0}
run: |
out = Cmd(`git diff -U0`) |> read |> String
if out == ""
exit(0)
else
@error "Some files have not been formatted !!!\n\n$out"
exit(1)
end
- name: Spell Check
uses: crate-ci/typos@master
- name: Version Check
shell: julia {0}
run: |
using Pkg
VERSION = VersionNumber(Pkg.TOML.parsefile("Project.toml")["version"])
BRANCH = ENV["GITHUB_REF_NAME"]
if ENV["GITHUB_EVENT_NAME"] == "pull_request"
# For pull_request events, return the head (aka., "from") branch,
# not the base (aka., "to") branch.
BRANCH = ENV["GITHUB_HEAD_REF"]
end
if startswith(BRANCH, "release-")
if (length(VERSION.prerelease) == length(VERSION.build))
println("Version $VERSION on release branch OK")
else
@error "Invalid version $VERSION on release branch"
exit(1)
end
elseif (ENV["GITHUB_REF_TYPE"] == "branch") && (BRANCH != "master")
if ("dev" in VERSION.prerelease) || ("dev" in VERSION.build)
println("Version $VERSION OK with dev-suffix on $BRANCH")
else
@error "Invalid version $VERSION on branch $BRANCH: must contain dev suffix"
exit(1)
end
else
println("Version $VERSION OK on $BRANCH")
end
exit(0)
- name: Changelog Check
shell: julia {0}
run: |
using Pkg
using Dates
VERSION = VersionNumber(Pkg.TOML.parsefile("Project.toml")["version"])
BRANCH = ENV["GITHUB_REF_NAME"]
CHANGELOG = read("NEWS.md", String)
TODAY = string(Dates.today())
if ("dev" in VERSION.prerelease) || ("dev" in VERSION.build)
if !contains(CHANGELOG, "## [Unreleased][]")
@error "NEWS.md for dev-version must contain Unreleased heading"
exit(1)
end
end
if startswith(BRANCH, "release-")
if contains(CHANGELOG, "## [Unreleased][]")
@error "NEWS.md for releases must not contain Unreleased heading"
exit(1)
end
release_header = "## [Version $VERSION][$VERSION] - $TODAY"
if !contains(CHANGELOG, release_header)
@error "NEWS.md must contain release header $(repr(release_header))"
exit(1)
end
rx_release_link = Regex(replace("[$VERSION]: https://github.com/JuliaDocs/DocumenterCitations.jl/compare/v(\\d.\\d.\\d)...v$VERSION", "."=>"\\.", "[" => "\\[", "]" => "\\]"))
release_link = match(rx_release_link, CHANGELOG)
if isnothing(release_link)
@error "NEWS.md must contain a link for the release $VERSION with the pattern $(repr(rx_release_link.pattern)) comparing $VERSION with the previous release"
exit(1)
else
previous_version = VersionNumber(release_link.captures[1])
if previous_version >= VERSION
@error "The release link $(repr(release_link.match)) must compare the range from the previous version, not $(previous_version)"
exit(1)
end
end
unreleased_link = "[Unreleased]: https://github.com/JuliaDocs/DocumenterCitations.jl/compare/v$VERSION...HEAD"
if !contains(CHANGELOG, unreleased_link)
@error "NEWS.md must contain link for future unreleased changes $(repr(unreleased_link)) (but no Unreleased header)"
exit(1)
end
end
println("NEWS.md OK")
exit(0)