Skip to content

Commit

Permalink
Merge pull request #34 from dic-iit/action/gh-pages
Browse files Browse the repository at this point in the history
Added changelog and action to update the documentation.
  • Loading branch information
S-Dafarra committed Feb 2, 2021
2 parents 960ed1b + 3fd80e9 commit 2ffa1ab
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 0 deletions.
51 changes: 51 additions & 0 deletions .github/workflows/gh-pages.yml
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
11 changes: 11 additions & 0 deletions CHANGELOG.md
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.

0 comments on commit 2ffa1ab

Please sign in to comment.