Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
GÉANT Service Orchestrator
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
GÉANT Orchestration and Automation Team
GAP
GÉANT Service Orchestrator
Commits
e016ae60
Verified
Commit
e016ae60
authored
3 months ago
by
Karel van Klink
Browse files
Options
Downloads
Patches
Plain Diff
Update CI
parent
40bd8735
No related branches found
No related tags found
1 merge request
!316
Replace Sphinx with MkDocs
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
.gitlab-ci.yml
+17
-24
17 additions, 24 deletions
.gitlab-ci.yml
docs/build-docs.sh
+2
-1
2 additions, 1 deletion
docs/build-docs.sh
docs/scripts/gen_wf_redirects.py
+1
-1
1 addition, 1 deletion
docs/scripts/gen_wf_redirects.py
with
20 additions
and
26 deletions
.gitlab-ci.yml
+
17
−
24
View file @
e016ae60
...
...
@@ -4,8 +4,8 @@ stages:
-
documentation
-
sonarqube
-
trigger_jenkins_build
-
publish-prod-1
-
publish-prod-2
-
publish-
docs-
prod-1
-
publish-
docs-
prod-2
#################################### tox - Testing and linting
run-tox-pipeline
:
...
...
@@ -50,16 +50,16 @@ build-documentation:
stage
:
documentation
tags
:
-
docker-executor
image
:
python:
latest
image
:
python:
3.12
before_script
:
-
cd $CI_PROJECT_DIR/docs
script
:
-
build-docs.sh
-
/bin/sh ./
build-docs.sh
artifacts
:
paths
:
-
public
-
docs/
public
##### Vale - Documentation linter
lint-documentation
:
...
...
@@ -82,40 +82,33 @@ lint-documentation:
-
vale --glob='!*/migrations/*' $CI_PROJECT_DIR/docs/ $CI_PROJECT_DIR/gso/
##### Publish documentation artefacts
publish-prod-
2
:
stage
:
publish-prod-
2
# First deploy to prod-
2
publish-
docs-
prod-
1
:
stage
:
publish-
docs-
prod-
1
# First deploy to prod-
1
tags
:
-
gap-docs-prod-2
-
gap-docs-prod-1
only
:
refs
:
-
main
# Only publish when on the main branch
-
master
# Only publish when on the main branch
needs
:
-
job
:
build-documentation
artifacts
:
true
script
:
-
rm -rf /var/www/gap-docs/*
-
mv $CI_PROJECT_DIR/public/* /var/www/gap-docs/
-
mv $CI_PROJECT_DIR/
docs/
public/* /var/www/gap-docs/
publish-prod-
1
:
stage
:
publish-prod-
1
# When successful, also deploy to prod-
1
publish-
docs-
prod-
2
:
stage
:
publish-
docs-
prod-
2
# When successful, also deploy to prod-
2
tags
:
-
gap-docs-prod-1
-
gap-docs-prod-2
only
:
refs
:
-
main
# Only publish when on the main branch
-
master
# Only publish when on the main branch
needs
:
-
job
:
build-documentation
artifacts
:
true
script
:
-
rm -rf /var/www/gap-docs/*
-
mv $CI_PROJECT_DIR/public/* /var/www/gap-docs/
-
mv $CI_PROJECT_DIR/
docs/
public/* /var/www/gap-docs/
sonarqube
:
stage
:
sonarqube
...
...
This diff is collapsed.
Click to expand it.
docs/build-docs.sh
+
2
−
1
View file @
e016ae60
...
...
@@ -5,7 +5,8 @@ set -o nounset
export
OSS_PARAMS_FILENAME
=
../gso/oss-params-example.json
export
TESTING
=
true
pip
install
pyyaml mkdocstrings-python mkdocs_gen_files mkdocs-material mkdocs-literate-nav mkdocs-redirects
pip
install
-e
..
python ./scripts/gen_wf_redirects.py
pip
install
mkdocstrings-python mkdocs_gen_files mkdocs-material mkdocs-literate-nav mkdocs-redirects
mkdocs build
--site-dir
public
This diff is collapsed.
Click to expand it.
docs/scripts/gen_wf_redirects.py
+
1
−
1
View file @
e016ae60
...
...
@@ -25,7 +25,7 @@ for path in sorted(src.rglob("*.py")):
if
len
(
parts
)
==
4
and
"
workflows
"
in
parts
:
# noqa: PLR2004
redirect_map
[
"
workflow/
"
+
parts
[
3
]
+
"
/index.md
"
]
=
"
https://docs.gap.geant.org/reference/
"
+
"
/
"
.
join
(
parts
)
with
Path
.
open
(
root
/
"
wf_redirects.yaml
"
,
"
w
"
)
as
redirect_file
:
with
Path
.
open
(
root
/
"
docs
"
/
"
wf_redirects.yaml
"
,
"
w
"
)
as
redirect_file
:
file_content
=
{
"
plugins
"
:
[
"
search
"
,
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment