From 3fd80e9c894c252d7ac4abc9f4cbfa69dc5e470e Mon Sep 17 00:00:00 2001 From: Stefano Date: Tue, 2 Feb 2021 15:54:02 +0100 Subject: [PATCH] Added changelog and action to update the documentation. --- .github/workflows/gh-pages.yml | 51 ++++++++++++++++++++++++++++++++++ CHANGELOG.md | 11 ++++++++ 2 files changed, 62 insertions(+) create mode 100644 .github/workflows/gh-pages.yml create mode 100644 CHANGELOG.md diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml new file mode 100644 index 00000000..918316a9 --- /dev/null +++ b/.github/workflows/gh-pages.yml @@ -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/ssh-agent@v0.4.1 + 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 "actions@github.com" + + - name: Clone and rebase + run: | + cd ${GITHUB_WORKSPACE} + git clone git@github.com:${{ 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 + diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..ef2c4134 --- /dev/null +++ b/CHANGELOG.md @@ -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.