Skip to content

Commit e63f04b

Browse files
mohamed-barakatmohamed-barakat
authored
Merge pull request #100 from mohamed-barakat/devel
comply with new package standards
2 parents 3ab46d8 + ab00f1d commit e63f04b

7 files changed

Lines changed: 93 additions & 55 deletions

File tree

‎.github/dependabot.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
2+
version: 2
3+
updates:
4+
- package-ecosystem: "github-actions"
5+
directory: "/" # Location of package manifests
6+
schedule:
7+
interval: "weekly"

‎.github/workflows/CompatHelper.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
name: CompatHelper
2-
32
on:
43
schedule:
5-
- cron: '00 00 * * *'
6-
4+
- cron: 0 0 * * *
5+
workflow_dispatch:
76
jobs:
87
CompatHelper:
98
runs-on: ubuntu-latest
@@ -13,4 +12,5 @@ jobs:
1312
- name: CompatHelper.main()
1413
env:
1514
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
15+
COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
1616
run: julia -e 'using CompatHelper; CompatHelper.main()'

‎.github/workflows/TagBot.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ on:
33
issue_comment:
44
types:
55
- created
6-
workflow_dispatch:
6+
workflow_dispatch:
77
jobs:
88
TagBot:
99
if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'

‎.github/workflows/Tests.yml‎

Lines changed: 41 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
name: Tests
2-
32
on:
43
push:
54
branches:
@@ -9,45 +8,58 @@ on:
98
- "*"
109
schedule:
1110
- cron: '0 0 * * *' ## daily
12-
11+
concurrency:
12+
# Skip intermediate builds: always.
13+
# Cancel intermediate builds: only if it is a pull request build.
14+
group: ${{ github.workflow }}-${{ github.ref }}
15+
cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
1316
jobs:
1417
test:
15-
name: Julia ${{ matrix.julia-version }} - ${{ matrix.os }} - x64
18+
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
1619
runs-on: ${{ matrix.os }}
17-
continue-on-error: ${{ matrix.julia-version == 'nightly' }}
1820
strategy:
1921
fail-fast: false
2022
matrix:
21-
julia-version:
23+
version:
2224
- '1.9'
2325
- 'nightly'
24-
julia-arch:
25-
- x64
2626
os:
2727
- ubuntu-latest
2828
# currently broken: https://github.com/homalg-project/CapAndHomalg.jl/issues/70
2929
#- macOS-latest
30-
31-
env:
32-
JULIA_TRACK_COVERAGE: yes
33-
30+
arch:
31+
- x64
32+
steps:
33+
- uses: actions/checkout@v4
34+
- uses: julia-actions/setup-julia@v1
35+
with:
36+
version: ${{ matrix.version }}
37+
arch: ${{ matrix.arch }}
38+
- uses: julia-actions/cache@v1
39+
- uses: julia-actions/julia-buildpkg@v1
40+
- uses: julia-actions/julia-runtest@v1
41+
- uses: julia-actions/julia-processcoverage@v1
42+
- uses: codecov/codecov-action@v3
43+
with:
44+
files: lcov.info
45+
docs:
46+
name: Documentation
47+
runs-on: ubuntu-latest
48+
permissions:
49+
contents: write
50+
statuses: write
3451
steps:
35-
- run: '[ "$GITHUB_EVENT_NAME" = "pull_request" ] || curl --fail -X PUT -H "Accept: application/vnd.github.v3+json" -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" https://api.github.com/repos/$GITHUB_REPOSITORY/actions/workflows/Tests.yml/enable'
36-
- uses: actions/checkout@v3
37-
38-
- name: Setup Julia environment
39-
uses: julia-actions/setup-julia@latest
52+
- uses: actions/checkout@v4
53+
- uses: julia-actions/setup-julia@v1
4054
with:
41-
version: ${{ matrix.julia-version }}
42-
43-
- name: "Build package"
44-
uses: julia-actions/julia-buildpkg@latest
45-
46-
- name: "Run tests"
47-
uses: julia-actions/julia-runtest@latest
48-
49-
- name: "Process coverage"
50-
uses: julia-actions/julia-processcoverage@v1
51-
52-
- name: "Upload to codecov.io"
53-
uses: codecov/codecov-action@v3
55+
version: '1'
56+
- uses: julia-actions/julia-buildpkg@v1
57+
- uses: julia-actions/julia-docdeploy@v1
58+
env:
59+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
60+
- run: |
61+
julia --project=docs -e '
62+
using Documenter: DocMeta, doctest
63+
using HomalgProject
64+
DocMeta.setdocmeta!(HomalgProject, :DocTestSetup, :(using HomalgProject); recursive=true)
65+
doctest(HomalgProject)'

‎.github/workflows/register.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Register Package
2+
on:
3+
workflow_dispatch:
4+
inputs:
5+
version:
6+
description: Version to register or component to bump
7+
required: true
8+
jobs:
9+
register:
10+
runs-on: ubuntu-latest
11+
permissions:
12+
contents: write
13+
steps:
14+
- uses: julia-actions/RegisterAction@latest
15+
with:
16+
token: ${{ secrets.GITHUB_TOKEN }}

‎docs/make.jl‎

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
1-
using Documenter, DocumenterMarkdown, HomalgProject
1+
using HomalgProject
2+
using Documenter
3+
using DocumenterMarkdown
24

35
makedocs(;
4-
modules = [HomalgProject],
5-
format = Documenter.HTML(assets = String[]),
6-
doctest = false,
7-
repo = "https://github.com/homalg-project/HomalgProject.jl/blob/{commit}{path}#L{line}",
8-
sitename = "HomalgProject.jl",
9-
authors = "Mohamed Barakat <mohamed.barakat@uni-siegen.de>",
10-
pages = ["Home" => "index.md", "Examples" => "examples.md"],
6+
modules=[HomalgProject],
7+
authors="Mohamed Barakat <mohamed.barakat@uni-siegen.de>",
8+
repo="https://github.com/homalg-project/HomalgProject.jl/blob/{commit}{path}#{line}",
9+
sitename="HomalgProject.jl",
10+
format=Documenter.HTML(;
11+
prettyurls=get(ENV, "Tests", "false") == "true",
12+
canonical="https://homalg-project.github.io/HomalgProject.jl",
13+
edit_link="master",
14+
assets=String[],
15+
),
16+
pages=[
17+
"Home" => "index.md",
18+
"Examples" => "examples.md"
19+
],
1120
)
1221

13-
deploydocs(; repo = "github.com/homalg-project/HomalgProject.jl")
22+
deploydocs(;
23+
repo="github.com/homalg-project/HomalgProject.jl",
24+
devbranch="master",
25+
)

‎docs/src/index.md‎

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -48,19 +48,6 @@ julia> Pkg.build("HomalgProject")
4848

4949
This will also clone the repositories listed in `CapAndHomalg.PACKAGES_TO_DOWNLOAD` using `DownloadAllPackagesFromHomalgProject` and compile the packages listed in `CapAndHomalg.PACKAGES_TO_COMPILE` using `GAP.Packages.install`(`pkgname`).
5050

51-
```@docs
52-
version
53-
PKG_DIR
54-
PACKAGES_TO_DOWNLOAD
55-
DownloadAllPackagesFromHomalgProject
56-
UpdateAllPackagesFromHomalgProject
57-
RemoveAllPackagesFromHomalgProject
58-
DownloadPackageFromHomalgProject
59-
UpdatePackageFromHomalgProject
60-
RemovePackageFromHomalgProject
61-
PACKAGES_TO_COMPILE
62-
```
63-
6451
## Software dependency
6552

6653
`HomalgProject` relies on the
@@ -109,3 +96,7 @@ This software is licensed under the [LGPL, version 3](https://www.gnu.org/licens
10996

11097
```@index
11198
```
99+
100+
```@autodocs
101+
Modules = [HomalgProject]
102+
```

0 commit comments

Comments
 (0)