Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions .github/workflows/docs-dispatch.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: docs-dispatch

# lockfamily.dev/docs is built by lockfamily's docs-site/build.py from this
# repository's README.md, CHANGELOG.md, GUIDE.md and docs/**. Its pages
# workflow rebuilds nightly; this dispatch makes a change to those files, or
# a release, show on the site within minutes.
#
# LOCKFAMILY_DOCS_TOKEN: a fine-grained token limited to
# DavidGodefroid/lockfamily, Contents read and write (lockfamily#39). Without
# it the job passes with a notice and the nightly build picks the change up.

on:
push:
branches: [main]
paths:
- README.md
- CHANGELOG.md
- GUIDE.md
- "docs/**"
release:
types: [published]

permissions: {}

jobs:
dispatch:
name: dispatch docs to lockfamily
runs-on: ubuntu-latest
permissions: {}
steps:
- name: send repository_dispatch (docs)
env:
GH_TOKEN: ${{ secrets.LOCKFAMILY_DOCS_TOKEN }}
run: |
if [ -z "$GH_TOKEN" ]; then echo "::notice::LOCKFAMILY_DOCS_TOKEN not set"; exit 0; fi
gh api repos/DavidGodefroid/lockfamily/dispatches -f event_type=docs
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,12 @@ one hub approves for all of them. Start at [lockfamily.dev](https://lockfamily.d
product or work around it: ask for the change, as
[GUIDE.md § 15](GUIDE.md#15-asking-for-a-lockkit-change) describes. Tests:
`go vet ./... && go test ./...`.
- **Docs:** docs are published at
[lockfamily.dev/docs](https://lockfamily.dev/docs/) from this repo's
Markdown. Adding a file under `docs/`, or renaming or removing a README H2
section, needs a matching change to
[lockfamily's `docs-site/nav.toml`](https://github.com/DavidGodefroid/lockfamily/blob/main/docs-site/nav.toml):
open a lockfamily PR, or the nightly docs build fails.
- **Security:** report vulnerabilities privately through
[GitHub security advisories](https://github.com/DavidGodefroid/lockkit/security/advisories/new).
- **License:** Apache License 2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).
Loading