-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
First try at doc building/uploading on github.
- Loading branch information
1 parent
1ae19f3
commit b4a355d
Showing
4 changed files
with
63 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
name: Build and upload docs | ||
|
||
on: | ||
# Runs on pushes targeting the default branch | ||
push: | ||
branches: ["main"] | ||
|
||
# Allows you to run this workflow manually from the Actions tab | ||
workflow_dispatch: | ||
|
||
# Make this workflow depend on the other one. | ||
workflow_run: | ||
workflows: | ||
- "GitHub CI" | ||
types: | ||
- success | ||
|
||
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | ||
permissions: | ||
contents: read | ||
pages: write | ||
id-token: write | ||
|
||
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | ||
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | ||
concurrency: | ||
group: "pages" | ||
cancel-in-progress: false | ||
|
||
jobs: | ||
# Single deploy job since we're just deploying | ||
deploy: | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
- name: Setup Pages | ||
uses: actions/configure-pages@v4 | ||
- name: Download artifact | ||
uses: actions/download-artifact@v4 | ||
with: | ||
name: docs | ||
- name: Upload docs | ||
uses: actions/upload-pages-artifact@v3 | ||
with: | ||
path: './doc/_build/html' | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -55,42 +55,5 @@ if [[ "${SPHINX_OUTPUT}" != "" ]]; then | |
fi | ||
echo "Sphinx ran successfully"; | ||
|
||
if [[ ! -z "${CI_PULL_REQUEST}" ]]; then | ||
echo "Testing a pull request, the generated documentation will not be uploaded."; | ||
exit 0; | ||
fi | ||
|
||
if [[ "${CIRCLE_BRANCH}" != "master" ]]; then | ||
echo "Branch is not master, the generated documentation will not be uploaded."; | ||
exit 0; | ||
fi | ||
|
||
# Check out the gh_pages branch in a separate dir. | ||
cd ../ | ||
git config --global push.default simple | ||
git config --global user.name "CircleCI" | ||
git config --global user.email "[email protected]" | ||
set +x | ||
git clone "https://${GH_TOKEN}@github.com/bluescarni/heyoka.git" heyoka_gh_pages -q | ||
set -x | ||
cd heyoka_gh_pages | ||
git checkout -b gh-pages --track origin/gh-pages; | ||
git rm -fr *; | ||
mv ../doc/_build/html/* .; | ||
git add *; | ||
# We assume here that a failure in commit means that there's nothing | ||
# to commit. | ||
git commit -m "Update Sphinx documentation, commit ${CIRCLE_SHA1} [skip ci]." || exit 0 | ||
PUSH_COUNTER=0 | ||
until git push -q | ||
do | ||
git pull -q | ||
PUSH_COUNTER=$((PUSH_COUNTER + 1)) | ||
if [ "$PUSH_COUNTER" -gt 3 ]; then | ||
echo "Push failed, aborting."; | ||
exit 1; | ||
fi | ||
done | ||
|
||
set +e | ||
set +x |