mirror of
https://github.com/vagrant-libvirt/vagrant-libvirt.git
synced 2025-02-25 18:55:27 -06:00
82202945ce
Switch from having all documentation contained within the README to publishing a jekyll static site of documentation under github pages. This allows for configuration and installation guides to be handled separately to make for the relevant pieces to be in smaller chunks and therefore easier to follow for users. Additionally a table of contents can now be included in a left navigation section that ensures it should be possible to quickly jump from the start to any section and back again. Include support for publishing previews and releases under separate directories to allow for them to exist at the same time as the other latest version of the documents. The navigation section also includes support for accessing any of the other versions published so that it easier to see what configuration options exist for a given release. These will be published automatically when releases are added.
26 lines
711 B
YAML
26 lines
711 B
YAML
name: Deploy Docs Preview Requires Label
|
|
on:
|
|
pull_request_target:
|
|
types:
|
|
- opened
|
|
- reopened
|
|
- synchronized
|
|
paths:
|
|
- 'docs/**'
|
|
|
|
permissions:
|
|
pull-requests: write
|
|
jobs:
|
|
notify-label-required:
|
|
if: ${{ !contains(github.event.pull_request.labels.*.name, 'preview-docs') }}
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Comment on label required for docs preview deploy
|
|
uses: marocchino/sticky-pull-request-comment@v2
|
|
with:
|
|
recreate: true
|
|
header: notify-label-required
|
|
message: |-
|
|
Maintainers: This PR updates the documentation, please review and apply
|
|
the label 'preview-docs' if satisfied it is safe to publish.
|