From 9e0afa5141e79f6856286577807eefbcc518618b Mon Sep 17 00:00:00 2001 From: Peter Date: Mon, 29 Nov 2021 19:12:10 +0100 Subject: [PATCH] Prepare for renovate bot --- .github/workflows/gh-pages.yml | 2 +- .github/workflows/renovate_check-build.yml | 23 ++++++++++++++++++++++ README.md | 5 +++-- requirements.txt | 3 +++ 4 files changed, 30 insertions(+), 3 deletions(-) create mode 100644 .github/workflows/renovate_check-build.yml create mode 100644 requirements.txt diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index 3a74c2445..ee0ae1475 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -16,7 +16,7 @@ jobs: run: | sudo apt-get -y update sudo apt-get -y install python3-pip - pip install mkdocs-material==7.3.6 pygments==2.10.0 mkdocs-redirects==1.0.3 + pip install -r requirements.txt - name: Build site 🔧 run: | diff --git a/.github/workflows/renovate_check-build.yml b/.github/workflows/renovate_check-build.yml new file mode 100644 index 000000000..9fb6eacdd --- /dev/null +++ b/.github/workflows/renovate_check-build.yml @@ -0,0 +1,23 @@ +name: Check build for renovate +on: + push: + branches: + - 'renovate/**' +jobs: + build-and-deploy: + runs-on: ubuntu-latest + steps: + - name: Checkout 📥 + uses: actions/checkout@v2.4.0 + with: + token: '${{ secrets.GHPAGES_ACTION_CHECKOUT_TOKEN_PAT }}' + + - name: Install dependencies 🐄 + run: | + sudo apt-get -y update + sudo apt-get -y install python3-pip + pip install -r requirements.txt + + - name: Build site 🔧 + run: | + mkdocs build --verbose --clean diff --git a/README.md b/README.md index 9da27310d..40db5bad7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![Build and deploy to gh-pages](https://github.com/mailcow/mailcow-dockerized-docs/actions/workflows/gh-pages.yml/badge.svg)](https://github.com/mailcow/mailcow-dockerized-docs/actions/workflows/gh-pages.yml) +[![Build and deploy to gh-pages](https://img.shields.io/github/workflow/status/mailcow/mailcow-dockerized-docs/Build%20and%20deploy%20to%20gh-pages/master?label=Build%20and%20deploy%20to%20gh-pages)](https://github.com/mailcow/mailcow-dockerized-docs/actions/workflows/gh-pages.yml) # mailcow: dockerized documentation @@ -9,6 +9,7 @@ https://mailcow.github.io/mailcow-dockerized-docs To build it locally, you need the [Material theme for MkDocs](https://squidfunk.github.io/mkdocs-material/), [MkDocs](https://www.mkdocs.org/) itself and [Pygments](http://pygments.org/). To install these with [pip](https://pip.pypa.io/en/stable/) and get it up and running, fire up your terminal and enter ``` -pip install mkdocs-material==7.3.6 pygments==2.10.0 mkdocs-redirects==1.0.3 +git clone https://github.com/mailcow/mailcow-dockerized-docs.git +pip install -r requirements.txt mkdocs serve ``` diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 000000000..877bd1729 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +mkdocs-material==7.3.6 +mkdocs-redirects==1.0.3 +pygments==2.10.0