Skip to content
This repository was archived by the owner on Apr 10, 2023. It is now read-only.
Open
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
a1976b0
Testing action (Looking at workspace filesystem)
Feb 10, 2021
f8ee7e5
Testing action (Fixing invalid branchname)
Feb 10, 2021
45f8be4
Testing action (Changed sphinx install method)
Feb 10, 2021
9a995f9
Testing action (Sudoing apt)
Feb 10, 2021
2add9c2
Testing Action (Changing import of serde for docs conf)
Feb 10, 2021
d08a5da
Testing Action (Investigating what directory is being worked in)
Feb 10, 2021
fa01a6e
Testing Action (Investigating what directory is being worked in)
Feb 10, 2021
035ef57
Testing Action (Trying to get serde to import properly)
Feb 10, 2021
aa12d99
Testing Action (Investigating runner file-system more)
Feb 10, 2021
729f899
Testing Action (Investigating runner file-system more)
Feb 10, 2021
6709f38
Testing Action (Investigating runner file-system more)
Feb 10, 2021
d872f36
Testing Action (Trying to make serde package available in PATH)
Feb 10, 2021
4ae2996
Testing Action (Trying to make serde package available in PATH)
Feb 10, 2021
be4059d
Testing Action (Trying to make serde package available in PYTHONPATH)
Feb 10, 2021
c4babb4
Testing Action (Path works -> Testing docs build)
Feb 10, 2021
b6b6f7c
Cleaning test files
Feb 10, 2021
00c468d
Testing Action: (Full test)
Feb 10, 2021
23d2d3f
Testing Action: (testing swap space method)
Feb 10, 2021
9782137
Testing Action: (testing swap space method)
Feb 10, 2021
7ab581c
Testing Action: (testing swap space method)
Feb 10, 2021
723175a
Testing Action: (checking gh-pages branch already in local)
Feb 10, 2021
67201d3
Testing Action: (testing git staging)
Feb 10, 2021
4e2306a
Testing Action: (Full workflow test)
Feb 10, 2021
326828b
Testing Action: (Added fancy version number thing)
Feb 10, 2021
bf7a4bc
Silenced fail exit code on no changes
Feb 10, 2021
667aa74
Cleaned test imports
Feb 10, 2021
47ab0d0
Cleaned accidental added line
Feb 10, 2021
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
36 changes: 36 additions & 0 deletions .github/workflows/build_docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Triggers the workflows on push or pull request events but only for the main branch
name: Generate new docs.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer if this was just docs. Same with the file name.

on:
# Allows you to run this workflows manually from the Actions tab
workflow_dispatch:

# A workflows run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflows contains a single job called "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest

# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# Runs a set of commands using the runners shell
- uses: actions/checkout@v2
with:
ref: master
Comment on lines +18 to +19
Copy link
Owner

@rossmacarthur rossmacarthur Feb 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure I understand why this is here 🤔. I think it would be assumed that the docs would be built from the branch running the workflow not always from master.

- uses: extractions/setup-just@v1

- name: Run a multi-line script
run: |
sudo apt-get install python3-sphinx
export PYTHONPATH=$GITHUB_WORKSPACE/src:$PYTHONPATH
just docs
git config --global user.name "Serde Docs Auto-Generator"
mkdir ../html_docs_swap_folder
cp -r docs/_build/html/* ../html_docs_swap_folder/
git fetch
git checkout -t origin/gh-pages
rm -rf ./*
cp -r ../html_docs_swap_folder/* ./
git add .
git diff-index --quiet HEAD || git commit -m "publish docs for $(git -C ../../.. rev-parse --short HEAD)"
git push
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See my comment on the PR about using an action for this