1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-12-05 04:18:12 +01:00
mkdocs-material/.github/workflows/ci.yml

170 lines
5.2 KiB
YAML
Raw Normal View History

2019-12-06 15:52:21 +01:00
# Copyright (c) 2016-2019 Martin Donath <martin.donath@squidfunk.com>
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
2019-12-08 17:09:45 +01:00
name: ci
2019-12-06 15:52:21 +01:00
on:
- push
- pull_request
# Jobs to run
jobs:
# Build theme
build:
runs-on: ubuntu-latest
steps:
# Limit clone depth to speed up build
- uses: actions/checkout@v1
with:
fetch-depth: 5
# Install Node runtime and dependencies
- uses: actions/setup-node@v1
with:
node-version: 10.x
- uses: actions/cache@v1
id: cache-node
with:
path: node_modules
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
${{ runner.os }}-build-${{ env.cache-name }}-
${{ runner.os }}-build-
${{ runner.os }}-
- if: steps.cache-node.outputs.cache-hit != 'true'
run: npm install
# Run linter and build distribution files
- run: npm run lint
- run: npm run build
Merge branch 'master' into refactor/rxjs-typescript (#1406) * Improved Lighthouse score (#1391) * a few accessibility fixes from lighthouse report * add rel="noopener" to external links * add title attribute to social links * add mimetype to manifest link and allow it to work behind auth * add font-display: swap to all the places where external fonts are used * remove font-display: swap from icon fonts * removed font-display from style blocks in base * add target="_blank" to social links * switch base fonts grabbed from Google back to display:fallback As per recommendation from https://developers.google.com/web/updates/2016/02/font-display#fallback * add target="_blank" to the footer links as well * Set `tabindex` to `0` for skip to content link (#1393) see https://web.dev/control-focus-with-tabindex/ * Added diff to CI build * Added built files * Bump @babel/cli from 7.7.5 to 7.7.7 Bumps [@babel/cli](https://github.com/babel/babel) from 7.7.5 to 7.7.7. - [Release notes](https://github.com/babel/babel/releases) - [Changelog](https://github.com/babel/babel/blob/master/CHANGELOG.md) - [Commits](https://github.com/babel/babel/compare/v7.7.5...v7.7.7) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump css-loader from 3.3.2 to 3.4.0 Bumps [css-loader](https://github.com/webpack-contrib/css-loader) from 3.3.2 to 3.4.0. - [Release notes](https://github.com/webpack-contrib/css-loader/releases) - [Changelog](https://github.com/webpack-contrib/css-loader/blob/master/CHANGELOG.md) - [Commits](https://github.com/webpack-contrib/css-loader/compare/v3.3.2...v3.4.0) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump eslint from 6.7.2 to 6.8.0 Bumps [eslint](https://github.com/eslint/eslint) from 6.7.2 to 6.8.0. - [Release notes](https://github.com/eslint/eslint/releases) - [Changelog](https://github.com/eslint/eslint/blob/master/CHANGELOG.md) - [Commits](https://github.com/eslint/eslint/compare/v6.7.2...v6.8.0) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump mini-css-extract-plugin from 0.8.0 to 0.9.0 Bumps [mini-css-extract-plugin](https://github.com/webpack-contrib/mini-css-extract-plugin) from 0.8.0 to 0.9.0. - [Release notes](https://github.com/webpack-contrib/mini-css-extract-plugin/releases) - [Changelog](https://github.com/webpack-contrib/mini-css-extract-plugin/blob/master/CHANGELOG.md) - [Commits](https://github.com/webpack-contrib/mini-css-extract-plugin/compare/v0.8.0...v0.9.0) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump @babel/plugin-transform-react-jsx from 7.7.4 to 7.7.7 Bumps [@babel/plugin-transform-react-jsx](https://github.com/babel/babel) from 7.7.4 to 7.7.7. - [Release notes](https://github.com/babel/babel/releases) - [Changelog](https://github.com/babel/babel/blob/master/CHANGELOG.md) - [Commits](https://github.com/babel/babel/compare/v7.7.4...v7.7.7) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump style-loader from 1.0.1 to 1.1.1 Bumps [style-loader](https://github.com/webpack-contrib/style-loader) from 1.0.1 to 1.1.1. - [Release notes](https://github.com/webpack-contrib/style-loader/releases) - [Changelog](https://github.com/webpack-contrib/style-loader/blob/master/CHANGELOG.md) - [Commits](https://github.com/webpack-contrib/style-loader/compare/v1.0.1...v1.1.1) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump webpack from 4.41.2 to 4.41.4 Bumps [webpack](https://github.com/webpack/webpack) from 4.41.2 to 4.41.4. - [Release notes](https://github.com/webpack/webpack/releases) - [Commits](https://github.com/webpack/webpack/compare/v4.41.2...v4.41.4) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump @babel/core from 7.7.5 to 7.7.7 Bumps [@babel/core](https://github.com/babel/babel) from 7.7.5 to 7.7.7. - [Release notes](https://github.com/babel/babel/releases) - [Changelog](https://github.com/babel/babel/blob/master/CHANGELOG.md) - [Commits](https://github.com/babel/babel/compare/v7.7.5...v7.7.7) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump @babel/preset-env from 7.7.6 to 7.7.7 Bumps [@babel/preset-env](https://github.com/babel/babel) from 7.7.6 to 7.7.7. - [Release notes](https://github.com/babel/babel/releases) - [Changelog](https://github.com/babel/babel/blob/master/CHANGELOG.md) - [Commits](https://github.com/babel/babel/compare/v7.7.6...v7.7.7) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Fix makefile * Update packages * build * "Fix" lint * Revert icon and makefile change Co-authored-by: Martin Donath <squidfunk@users.noreply.github.com> Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2019-12-25 15:09:36 +01:00
# Check diff after build
- run: git diff --name-only
2019-12-06 15:52:21 +01:00
# Upload distribution files
- uses: actions/upload-artifact@v1
if: startsWith(github.ref, 'refs/tags')
2019-12-06 15:52:21 +01:00
with:
name: material
path: material
# Build and deploy documentation site
deploy:
if: github.event_name != 'pull_request' && github.ref == 'refs/heads/master'
runs-on: ubuntu-latest
steps:
# Limit clone depth to speed up build
- uses: actions/checkout@v1
with:
fetch-depth: 5
# Install Python runtime and dependencies
- uses: actions/setup-python@v1
with:
python-version: 3.x
- uses: actions/cache@v1
id: cache-python
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- if: steps.cache-python.outputs.cache-hit != 'true'
run: pip install -r requirements.txt
# Set configuration for repository and deploy documentation
- env:
GH_TOKEN: ${{ secrets.GH_TOKEN }}
GH_NAME: ${{ secrets.GH_NAME }}
GH_EMAIL: ${{ secrets.GH_EMAIL }}
run: |
REMOTE="https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material"
git config --global user.name "${GH_NAME}"
git config --global user.email "${GH_EMAIL}"
git remote set-url origin ${REMOTE}
# Install theme
2019-12-06 16:20:31 +01:00
- run: python setup.py install
2019-12-06 15:52:21 +01:00
# Build documentation
- env:
GOOGLE_ANALYTICS_KEY: ${{ secrets.GOOGLE_ANALYTICS_KEY }}
run: |
2019-12-06 15:52:21 +01:00
mkdocs gh-deploy --force
mkdocs --version
# Publish Python package and Docker image
publish:
if: startsWith(github.ref, 'refs/tags')
needs: build
runs-on: ubuntu-latest
steps:
# Limit clone depth to speed up build
- uses: actions/checkout@v1
with:
fetch-depth: 5
2019-12-06 15:58:27 +01:00
# Ensure latest build if repository is not up-to-date
- run: rm -rf material
2019-12-06 15:52:21 +01:00
# Download distribution files
- uses: actions/download-artifact@v1
with:
name: material
# Install Python runtime and dependencies
- uses: actions/setup-python@v1
with:
python-version: 3.x
- run: pip install --upgrade setuptools wheel twine
# Build and test Docker image
- run: |
docker build -t ${GITHUB_REPOSITORY} .
docker run --rm -i -v $(pwd):/docs ${GITHUB_REPOSITORY} \
build --theme material
# Build Python package
- run: python setup.py build sdist bdist_wheel --universal
# Push release to PyPI
2019-12-11 18:11:11 +01:00
- env:
PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }}
2019-12-11 18:22:12 +01:00
PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
run: twine upload -u ${PYPI_USERNAME} -p ${PYPI_PASSWORD} dist/*
2019-12-06 15:52:21 +01:00
# Push image to Docker Hub
2019-12-11 18:11:11 +01:00
- env:
DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
2019-12-11 18:24:23 +01:00
run: |
2019-12-06 15:52:21 +01:00
docker login -u ${DOCKER_USERNAME} -p ${DOCKER_PASSWORD}
docker tag ${GITHUB_REPOSITORY} ${GITHUB_REPOSITORY}:${GITHUB_REF##*/}
docker tag ${GITHUB_REPOSITORY} ${GITHUB_REPOSITORY}:latest
docker push ${GITHUB_REPOSITORY}