YDA-5981: add role for reporting storage data #470
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
name: Documentation | |
on: | |
push: | |
branches: | |
- development | |
paths: | |
- 'docs/**' | |
- '.github/workflows/documentation.yml' | |
jobs: | |
build: | |
runs-on: ubuntu-22.04 | |
steps: | |
- uses: actions/checkout@v4 | |
# Cache Ruby dependencies across runs, in order to speed up jobs | |
- uses: actions/cache@v4 | |
with: | |
path: docs/vendor/bundle | |
key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }} | |
restore-keys: | | |
${{ runner.os }}-gem- | |
- name: Install Jekyll dependencies | |
run: | | |
cd docs | |
sudo apt-get update | |
sudo apt-get install -y ruby ruby-dev make racc gcc g++ | |
sudo gem install bundler -v 2.5.4 --no-document | |
bundle config path vendor/bundle | |
bundle install --jobs 4 | |
bundle add webrick | |
- name: Build test site | |
run: | | |
cd docs | |
bundle exec jekyll build --config _config_test.yml | |
- name: Run basic HTML checks | |
run: | | |
sudo apt-get update | |
sudo apt-get install -y libxslt-dev libxml2-dev zlib1g-dev | |
sudo gem install html-proofer --no-document -v 3.19.4 | |
cd docs | |
htmlproofer _site --url-ignore "/#.*/" --disable-external | |
env: | |
NOKOGIRI_USE_SYSTEM_LIBRARIES: true | |
- name: Check external links with Linkchecker | |
run: | | |
sudo apt-get install -y linkchecker | |
echo -e "[checking]\nlocalwebroot=$(realpath _site)" > lc.config | |
cd docs | |
linkchecker -f lc.config _site | |
- name: Build production site | |
run: | | |
cd docs | |
rm -rf _site | |
bundle exec jekyll build --config _config_prod.yml | |
- name: Deploy 🚀 | |
uses: JamesIves/github-pages-deploy-action@releases/v3 | |
with: | |
ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }} | |
BRANCH: gh-pages | |
FOLDER: docs/_site |