-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Jakub Dzikowski <[email protected]>
- Loading branch information
Showing
2 changed files
with
67 additions
and
1 deletion.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
name: Manual Docs Publishing | ||
on: | ||
workflow_dispatch: | ||
inputs: | ||
target_version: | ||
description: 'Tag to publish docs for (e.g., v1.2.3)' | ||
required: true | ||
type: string | ||
|
||
env: | ||
PAGES_BRANCH: gh-pages | ||
HTTPS_REMOTE: "https://${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}" | ||
|
||
jobs: | ||
publish-pages: | ||
name: Publish Pages | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Install project dependencies | ||
run: npm install | ||
- name: Generate typedocs | ||
run: | | ||
npm run typedoc-chain-api | ||
npm run typedoc-chain-client | ||
npm run typedoc-chaincode | ||
npm run typedoc-chain-connect | ||
npm run typedoc-chain-test | ||
npm run replace-readme-docs | ||
- name: Install google-chrome | ||
run: | | ||
wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb | ||
sudo dpkg -i google-chrome*.deb | ||
- name: Install python3 and pip | ||
run: | | ||
sudo apt-get install -y python3 | ||
sudo apt-get install -y python3-pip python3-pillow python3-cffi python3-brotli gcc musl-dev python3-dev | ||
- name: Setup Node.js | ||
uses: actions/setup-node@v3 | ||
with: | ||
node-version: 18 | ||
- name: Install mermaid-cli | ||
run: npm install -g @mermaid-js/mermaid-cli | ||
- name: Install pip packages | ||
run: pip3 install mkdocs==1.5.3 mkdocs-material==9.4.8 mike==1.1.2 beautifulsoup4==4.9.3 setuptools==58.2.0 mkdocs-awesome-pages-plugin==2.9.2 | ||
- name: Git config | ||
run: | | ||
git config --global user.email "${GITHUB_ACTOR}" | ||
git config --global user.name "${GITHUB_ACTOR}@gala.games" | ||
- name: Clone mkdocs-with-pdf fixed branch and install | ||
run: | | ||
git clone -b render-mermaid-png https://github.com/Fuerback/mkdocs-with-pdf.git | ||
cd mkdocs-with-pdf | ||
sudo python3 setup.py install | ||
cd .. | ||
- name: Mkdocs build | ||
run: | | ||
mkdocs build | ||
- name: Push a new version of the docs | ||
run: | | ||
git stash | ||
git fetch origin $PAGES_BRANCH && git -b checkout $PAGES_BRANCH origin/$PAGES_BRANCH || git checkout $PAGES_BRANCH || echo "Pages branch not deployed yet." | ||
git checkout $GITHUB_SHA | ||
mike deploy --rebase --prefix docs -r $HTTPS_REMOTE -p -b $PAGES_BRANCH -u ${{ inputs.target_version }} latest | ||
mike set-default --rebase --prefix docs -r $HTTPS_REMOTE -p -b $PAGES_BRANCH latest | ||
git checkout $PAGES_BRANCH -- docs/ |
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