-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #34 from dic-iit/action/gh-pages
Added changelog and action to update the documentation.
- Loading branch information
Showing
2 changed files
with
62 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
name: GitHub Pages | ||
|
||
on: | ||
release: | ||
types: [published] | ||
|
||
jobs: | ||
docs: | ||
name: "Docs Update" | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@master | ||
- uses: webfactory/[email protected] | ||
with: | ||
ssh-private-key: ${{ secrets.SSH_PRIVATE_GH_PAGES }} | ||
- name: Dependencies | ||
run: | | ||
sudo apt update | ||
sudo apt install -y xsltproc doxygen doxygen-doc texlive ghostscript graphviz | ||
- name: Check remote | ||
run: git ls-remote --heads --exit-code https://github.com/${{ github.repository }}.git gh-pages | ||
|
||
- name: Configure Git | ||
run: | | ||
git config --global push.default upstream | ||
git config --global user.name "GitHub Actions" | ||
git config --global user.email "[email protected]" | ||
- name: Clone and rebase | ||
run: | | ||
cd ${GITHUB_WORKSPACE} | ||
git clone [email protected]:${{ github.repository }}.git gh-pages | ||
cd gh-pages | ||
git checkout gh-pages | ||
git rebase master | ||
- name: Build Doxygen | ||
run: | | ||
cd ${GITHUB_WORKSPACE}/gh-pages/doxygen | ||
sed -i 's/PROJECT_NUMBER = .*/PROJECT_NUMBER = ${{ github.event.release.tag_name }}/' Doxyfile | ||
doxygen ./Doxyfile | ||
- name: Commit and push | ||
run: | | ||
cd ${GITHUB_WORKSPACE}/gh-pages | ||
git add . | ||
git commit --amend --no-edit | ||
git push --force-with-lease | ||
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,11 @@ | ||
# Changelog | ||
All notable changes to this project will be documented in this file. | ||
|
||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | ||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
||
## [Unreleased] | ||
|
||
## [0.1.0] - 2021-02-02 | ||
|
||
- First version implemented. |