Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Documentation
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
Service Desk
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
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Helmholtz Metadata Collaboration
HMC Public
unHIDE
Documentation
Commits
7d0dbddd
Commit
7d0dbddd
authored
2 years ago
by
Jens Bröder
Browse files
Options
Downloads
Patches
Plain Diff
Update github CI script to deploy pages
parent
9a45d1bc
Branches
main
No related tags found
No related merge requests found
Pipeline
#200730
passed
2 years ago
Stage: build
Stage: deploy
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
.github/workflows/deploy-docs.yml
+62
-32
62 additions, 32 deletions
.github/workflows/deploy-docs.yml
with
62 additions
and
32 deletions
.github/workflows/deploy-docs.yml
+
62
−
32
View file @
7d0dbddd
# Workflow to build and deploy the static sites generated with jupyter-book to GitHub Pages
name
:
deploy-docs
on
:
push
:
branches
:
-
'
main'
branches
:
[
'
main'
]
workflow_dispatch
:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions
:
contents
:
read
pages
:
write
id-token
:
write
# Allow one concurrent deployment
concurrency
:
group
:
"
pages"
cancel-in-progress
:
true
jobs
:
deploy-book
:
build-docs
:
runs-on
:
ubuntu-latest
steps
:
-
name
:
Checkout
-
uses
:
actions/checkout@v3
# Install dependencies
-
name
:
Set up Python
3.7
uses
:
actions/setup-python@v1
with
:
python-version
:
3.7
-
name
:
Install dependencies
run
:
|
pip install -U jupyter-book
# Build the docs
-
name
:
Build the docs
run
:
|
jupyter-book clean docs
jupyter-book build docs
-
name Upload artifact
uses
:
actions/upload-pages-artifact@v1
with
:
path
:
'
./docs/_build/html'
#- name: Create cname file
# uses: finnp/create-file-action@master
# env:
# FILE_NAME: "./docs/_build/html/CNAME"
# FILE_DATA: "unhide-docs.helmholtz-metadaten.de"
# Push the book's HTML to github-pages
#- name: GitHub Pages action
# uses: peaceiris/actions-gh-pages@v3.6.1
# with:
# github_token: ${{ secrets.GITHUB_TOKEN }}
# publish_dir: ./docs/_build/html
deploy
:
environment
:
name
:
github-pages
url
:
${{ steps.deployment.outputs.page_url }}
runs-on
:
ubuntu-latest
needs
:
build-docs
steps
:
-
uses
:
actions/checkout@v2
# Install dependencies
-
name
:
Set up Python
3.7
uses
:
actions/setup-python@v1
with
:
python-version
:
3.7
-
name
:
Install dependencies
run
:
|
pip install -U jupyter-book
# Build the book
-
name
:
Build the docs
run
:
|
jupyter-book clean docs
jupyter-book build docs
-
name
:
Create cname file
uses
:
finnp/create-file-action@master
env
:
FILE_NAME
:
"
./docs/_build/html/CNAME"
FILE_DATA
:
"
unhide-docs.helmholtz-metadaten.de"
# Push the book's HTML to github-pages
-
name
:
GitHub Pages action
uses
:
peaceiris/actions-gh-pages@v3.6.1
with
:
github_token
:
${{ secrets.GITHUB_TOKEN }}
publish_dir
:
./docs/_build/html
-
name
:
Deploy to GitHub Pages
id
:
deployment
uses
:
actions/deploy-pages@v1
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