Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rebuild and deploy the docs to GitHub pages #39

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .github/workflows/build-and-deploy-gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# This action rebuilds the docs whenever there is a change (push),
# and deplys it automatically on GitHub pages (the branch gh-pages).
#
name: Build and Deploy GitHub Pages
on:
push:
branches:
- main-disabled # Remove '-disabled' to activate this action
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2.3.1
- uses: actions/setup-node@v2
with:
node-version: '14'

- run: npm i -g @antora/cli @antora/site-generator-default antora-site-generator-lunr
- run: ./build.sh

- name: Deploy to GitHub Pages
uses: JamesIves/github-pages-deploy-action@4.1.4
with:
branch: gh-pages # The branch the action should deploy to.
folder: html # The folder the action should deploy.
21 changes: 21 additions & 0 deletions .github/workflows/build-on-pull-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# The idea of this action is to be executed on a pull request,
# in order to check automatically that the proposed changes
# do not break anything.
# However we don't have a way for testing antora files yet.
#
name: Build GitHub Pages
on:
pull_request:
branches: [ main-disabled ] # disabled for the time being because it does not do what it should
types: [ opened, edited, synchronize, reopened, ready_for_review ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2.3.1
- uses: actions/setup-node@v2
with:
node-version: '14'

- run: npm i -g @antora/cli @antora/site-generator-default antora-site-generator-lunr
- run: ./build.sh # This is supposed to be a command that fails if there are any errors on the asciidoc pages