mirror of
https://github.com/narrrl/proton-drive-linux.git
synced 2026-11-03 16:41:26 +01:00
nvrl
9c30ff8276
- scripts/publish-wiki.sh publishes every page listed in SECTIONS, copies images, writes a sectioned sidebar and footer, and removes stale pages. --check fails on links to missing files or headings and on docs pages that are neither published nor excluded. - New wiki.yml runs the check on pull requests and pushes to main, and publishes when release.yml calls it or when started by hand. - Split USER_GUIDE.md into topic pages (files, synced folders, photos, sharing, computers, launcher and tray); add Getting started and FAQ. - Make the COPR repository the main Fedora path, with update and uninstall steps for every package type. - Fix the stale CAPTCHA note in CLI.md, document pdfs unlock and lock, and drop the broken AGENTS.md link from CONTRIBUTING.md.
78 lines
2.0 KiB
YAML
78 lines
2.0 KiB
YAML
name: Wiki
|
|
|
|
# docs/ is the source of the GitHub wiki (docs/DEVELOPMENT.md#common-changes).
|
|
# Every change to the documentation checks its links; release.yml calls this
|
|
# once the release is published, so the wiki documents the latest release. Run
|
|
# it from the Actions tab to publish main in between.
|
|
on:
|
|
push:
|
|
branches: [main]
|
|
paths:
|
|
- 'docs/**'
|
|
- 'images/**'
|
|
- 'README.md'
|
|
- 'CONTRIBUTING.md'
|
|
- 'SECURITY.md'
|
|
- 'scripts/publish-wiki.sh'
|
|
- '.github/workflows/wiki.yml'
|
|
pull_request:
|
|
paths:
|
|
- 'docs/**'
|
|
- 'images/**'
|
|
- 'README.md'
|
|
- 'CONTRIBUTING.md'
|
|
- 'SECURITY.md'
|
|
- 'scripts/publish-wiki.sh'
|
|
- '.github/workflows/wiki.yml'
|
|
workflow_call:
|
|
inputs:
|
|
ref:
|
|
description: 'Tag or branch to publish'
|
|
required: true
|
|
type: string
|
|
workflow_dispatch:
|
|
inputs:
|
|
ref:
|
|
description: 'Tag or branch to publish'
|
|
required: false
|
|
default: 'main'
|
|
type: string
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
check:
|
|
name: Check documentation links
|
|
if: inputs.ref == ''
|
|
runs-on: ubuntu-24.04
|
|
steps:
|
|
- uses: actions/checkout@v7
|
|
|
|
- name: Check links
|
|
run: scripts/publish-wiki.sh --check "$RUNNER_TEMP"
|
|
|
|
publish:
|
|
name: Publish to the wiki
|
|
# Set only by release.yml and the Actions tab, so pushes and pull requests
|
|
# never publish.
|
|
if: inputs.ref != ''
|
|
runs-on: ubuntu-24.04
|
|
concurrency:
|
|
group: wiki-publish
|
|
cancel-in-progress: false
|
|
permissions:
|
|
contents: write
|
|
steps:
|
|
- uses: actions/checkout@v7
|
|
with:
|
|
ref: ${{ inputs.ref }}
|
|
|
|
- name: Publish
|
|
env:
|
|
WIKI_REMOTE: https://x-access-token:${{ github.token }}@github.com/${{ github.repository }}.wiki.git
|
|
run: |
|
|
git config --global user.name 'github-actions[bot]'
|
|
git config --global user.email '41898282+github-actions[bot]@users.noreply.github.com'
|
|
scripts/publish-wiki.sh --push "$RUNNER_TEMP"
|