mirror of
https://github.com/docker-mailserver/docker-mailserver
synced 2025-05-04 00:55:28 +02:00
6b4627ceab
**Overview of changes:** - Runner bumped from Ubuntu 22.04 => 24.04 - Revised inline documentation for maintainers. - The output of `build-docs.sh` is now grouped in the steps action log, and now hides the noise from pulling the image via `docker run`. - Removed the separate `tar` steps with ZSTD as there is only a directory to archive with recent changes to this workflow. The `upload` + `download` actions are sufficient. - The `workflow_run` job has had the PR context restore step extracted to a separate job to minimize noise. - `actions-netlify` is still effectively the same functionality. - `github-token` is no longer configured as it doesn't appear needed with the functions disabled. - Opt-out of the GH deployments feature which is not needed.
75 lines
3.3 KiB
YAML
75 lines
3.3 KiB
YAML
name: 'Documentation (PR)'
|
|
|
|
on:
|
|
pull_request:
|
|
paths:
|
|
- 'docs/**'
|
|
- '.github/workflows/scripts/docs/build-docs.sh'
|
|
- '.github/workflows/docs-preview-prepare.yml'
|
|
|
|
# If this workflow is triggered while already running for the PR, cancel any earlier running instances:
|
|
# Instances of the 2nd phase of this workflow (via `workflow_run`) lack any concurrency limits due to added complexity.
|
|
concurrency:
|
|
group: deploypreview-pullrequest-${{ github.event.pull_request.number }}
|
|
cancel-in-progress: true
|
|
|
|
env:
|
|
# Build output directory (created by the mkdocs-material container, keep this in sync with `build-docs.sh`):
|
|
BUILD_DIR: docs/site/
|
|
# These two are only needed to construct `PREVIEW_URL`:
|
|
PREVIEW_SITE_NAME: dms-doc-previews
|
|
PREVIEW_SITE_PREFIX: pullrequest-${{ github.event.pull_request.number }}
|
|
|
|
# `pull_request` workflow is unreliable alone: Non-collaborator contributions lack access to secrets for security reasons.
|
|
# A separate workflow (docs-preview-deploy.yml) handles the deploy after the potentially untrusted code is first run in this workflow.
|
|
# See: https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
|
|
permissions:
|
|
# Required by `actions/checkout` for git checkout:
|
|
contents: read
|
|
|
|
jobs:
|
|
prepare-preview:
|
|
name: 'Build Preview'
|
|
runs-on: ubuntu-24.04
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
# ================== #
|
|
# Build docs preview #
|
|
# ================== #
|
|
|
|
- name: 'Build with mkdocs-material via Docker'
|
|
working-directory: docs/
|
|
env:
|
|
PREVIEW_URL: 'https://${{ env.PREVIEW_SITE_PREFIX }}--${{ env.PREVIEW_SITE_NAME }}.netlify.app/'
|
|
run: |
|
|
# Adjust `mkdocs.yml` for the preview build requirements:
|
|
# - Replace production `site_url` with the preview URL (only affects the canonical link: https://en.wikipedia.org/wiki/Canonical_link_element#HTML)
|
|
# - Prepend Netlify logo link to `copyright` content
|
|
sed -i "s|^site_url:.*|site_url: '${{ env.PREVIEW_URL }}'|" mkdocs.yml
|
|
|
|
# Insert branding into page content (Netlify OSS plan requirement):
|
|
# - `mkdocs-material` does not provide a better way to do this.
|
|
# - Prepends HTML to the copyright text and then aligns the logo to the right-side of the page.
|
|
NETLIFY_BRANDING='<a href="https://www.netlify.com/"><img alt="Deploys by Netlify" src="https://www.netlify.com/img/global/badges/netlify-color-accent.svg" style="float: right;"></a>'
|
|
sed -i "s|^copyright: '|copyright: '${NETLIFY_BRANDING}|" mkdocs.yml
|
|
# Override a CSS media query for the parent element to always be full width:
|
|
echo '.md-footer-copyright { width: 100%; }' >> content/assets/css/customizations.css
|
|
|
|
# Build and prepare for upload:
|
|
echo "::group::Build (stdout)"
|
|
bash ../.github/workflows/scripts/docs/build-docs.sh
|
|
echo "::endgroup::"
|
|
|
|
# ============================== #
|
|
# Volley over to secure workflow #
|
|
# ============================== #
|
|
|
|
# Archives directory `path` into a ZIP file:
|
|
- name: 'Upload artifact for workflow transfer'
|
|
uses: actions/upload-artifact@v4
|
|
with:
|
|
name: preview-build
|
|
path: ${{ env.BUILD_DIR }}
|
|
retention-days: 1
|