mirror of
https://github.com/ChrisTitusTech/linutil.git
synced 2024-11-05 13:15:21 +00:00
01d571fc9e
* remove contributing guidelines duplicate `docs/contributing.md` is now auto generated * Commit Contributing Guidelines * core `xtask` functionality * almost there * write panic * almost almost there * there. * remove empty descriptions * better contributing.md comment * Commit Contributing Guidelines * remove entries without descriptions --------- Co-authored-by: adamperkowski <adamperkowski@users.noreply.github.com>
47 lines
1.3 KiB
YAML
47 lines
1.3 KiB
YAML
name: GitHub Pages Deploy
|
|
|
|
on:
|
|
push:
|
|
paths:
|
|
- '.github/mkdocs.yml'
|
|
- '.github/requirements.txt'
|
|
- 'docs/**'
|
|
- 'overrides/**'
|
|
- '.github/CONTRIBUTING.md'
|
|
workflow_dispatch:
|
|
|
|
jobs:
|
|
build-and-deploy:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Checkout Repository
|
|
uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: '0' # Fetch all commit history for all branches as well as tags.
|
|
|
|
- name: Copy Contributing Guidelines
|
|
run: |
|
|
echo "<!-- THIS FILE IS GENERATED AUTOMATICALLY. EDIT .github/CONTRIBUTING.md -->\n\n$(cat .github/CONTRIBUTING.md)" > 'docs/contributing.md'
|
|
|
|
- uses: stefanzweifel/git-auto-commit-action@v5
|
|
with:
|
|
commit_message: Commit Contributing Guidelines
|
|
file_pattern: "docs/contributing.md"
|
|
add_options: '--force'
|
|
if: success()
|
|
|
|
- name: Setup Python
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: 3.x # Install latest Stable release of Python 3
|
|
cache: 'pip' # Caching pip dependencies
|
|
|
|
- name: Install Necessary Dependencies
|
|
run: pip install -r .github/requirements.txt
|
|
|
|
- name: Build & Deploy using mkdocs
|
|
env:
|
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
run: mkdocs gh-deploy --force -f .github/mkdocs.yml
|