Add XML field explanations #90
Workflow file for this run
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: CI | |
on: [push, pull_request] | |
jobs: | |
lint: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: 3.x | |
- name: Install linters | |
run: | | |
pip install $(grep yamllint requirements.txt) | |
- name: Lint YAML files | |
run: yamllint . | |
- name: Lint Markdown files | |
uses: DavidAnson/markdownlint-cli2-action@v15 | |
with: | |
globs: "**/*.md" | |
build: | |
needs: lint | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: Setup python | |
uses: actions/[email protected] | |
with: | |
python-version: 3.x | |
- name: Install dependencies | |
run: pip install -r requirements.txt | |
- name: Build documentation | |
run: mkdocs build | |
deploy: | |
if: github.event_name == 'push' && contains(fromJson('["refs/heads/master", "refs/heads/main"]'), github.ref) | |
needs: build | |
name: Deploy docs | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
sparse-checkout: | | |
docs | |
- name: Setup python | |
uses: actions/[email protected] | |
with: | |
python-version: 3.x | |
- name: Install dependencies | |
run: pip install -r requirements.txt | |
- name: Deploy to GitHub Pages | |
run: mkdocs gh-deploy --force | |
# make_public: | |
# needs: builds | |
# runs-on: ubuntu-latest | |
# if: github.ref == 'refs/heads/master' | |
# steps: | |
# - name: clear CF cache | |
# run: | | |
# curl -X GET "https://api.cloudflare.com/client/v4/user/tokens/verify" \ | |
# -H "Authorization: Bearer ${{ secrets.CLOUDFLARE_CLEAR_CACHE }}" \ | |
# -H "Content-Type:application/json" | |
# - name: notify discord | |
# uses: appleboy/discord-action@master | |
# with: | |
# webhook_id: ${{ secrets.WEBHOOK_ID }} | |
# webhook_token: ${{ secrets.WEBHOOK_TOKEN }} | |
# username: "Selfhosters.net" | |
# avatar_url: "https://avatars3.githubusercontent.com/u/52747488?s=200" | |
# message: "New stuff has been added to the wiki" |