Skip to content

feat: migrate documentation to Hugo #227

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SlavaKatiukha wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: migrate documentation to Hugo #227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
16 changes: 12 additions & 4 deletions .devcontainer/devcontainer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "Devbox Remote Container",
"name": "Cloud Scripting documentation",
"build": {
"dockerfile": "./Dockerfile",
"context": ".."
Expand All @@ -14,9 +14,17 @@
"DavidAnson.vscode-markdownlint",
"shd101wyy.markdown-preview-enhanced",
"GitHub.copilot",
"GitHub.copilot-chat"
"GitHub.copilot-chat",
"eliostruyf.vscode-front-matter",
"kaellarkin.hugo-shortcode-syntax",
"budparr.language-hugo-vscode"
]
}
},
"remoteUser": "devbox"
}
"remoteUser": "devbox",
"postCreateCommand": "git submodule update --init --recursive",
"forwardPorts": [
8000,
1313
]
}
54 changes: 54 additions & 0 deletions .github/workflows/build-release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Build complete Hugo release
on:
workflow_dispatch:
permissions:
contents: read
jobs:
build:
runs-on: ubuntu-24.04
outputs:
artifact-id: ${{ steps.upload.outputs.artifact-id }}
artifact-digest: ${{ steps.upload.outputs.artifact-digest }}
archive-sha256: ${{ steps.archive.outputs.sha256 }}
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
fetch-depth: 0
submodules: recursive
persist-credentials: false
- uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
with:
python-version-file: '.python-version'
- run: bash scripts/deploy/setup-ci.sh
- uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
with:
version: '0.9.28'
enable-cache: true
- run: uv sync --locked
- run: uv run --locked python -m unittest discover -s tests/migration
- name: Assemble root and every retained release from immutable pins
run: task build-all
- run: task validate
- name: Package the validated complete artifact once
id: archive
shell: bash
run: |
set -euo pipefail
uv run --locked python -m scripts.deploy.artifact package build/artifact migration/release-sources.yaml build/delivery/cloudscripting-docs.tar.gz build/delivery/package-validation.json
digest=$(cut -d ' ' -f 1 build/delivery/cloudscripting-docs.tar.gz.sha256)
printf 'sha256=%s\n' "$digest" >> "$GITHUB_OUTPUT"
- uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
id: upload
with:
name: cloudscripting-docs-release
path: build/delivery/
if-no-files-found: error
compression-level: 0
retention-days: 30
- name: Record exact promotion identities
env:
ARTIFACT_ID: ${{ steps.upload.outputs.artifact-id }}
GITHUB_ARTIFACT_DIGEST: ${{ steps.upload.outputs.artifact-digest }}
ARCHIVE_SHA256: ${{ steps.archive.outputs.sha256 }}
run: |
printf 'Build run: `%s`\n\nArtifact ID: `%s`\n\nGitHub artifact digest: `%s`\n\nArchive SHA-256: `%s`\n' "$GITHUB_RUN_ID" "$ARTIFACT_ID" "$GITHUB_ARTIFACT_DIGEST" "$ARCHIVE_SHA256" >> "$GITHUB_STEP_SUMMARY"
95 changes: 95 additions & 0 deletions .github/workflows/deploy-production.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
name: Deploy production accepted artifact
on:
workflow_dispatch:
inputs:
build_run_id:
description: Successful Build complete Hugo release run ID
required: true
type: string
artifact_id:
description: Exact cloudscripting-docs-release artifact ID from that run
required: true
type: string
archive_sha256:
description: Accepted archive SHA-256 (same archive for staging and production)
required: true
type: string
permissions:
contents: read
actions: read
concurrency:
group: cloudscripting-docs-production
cancel-in-progress: false
jobs:
deploy:
runs-on: ubuntu-24.04
environment: production
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
fetch-depth: 0
submodules: recursive
persist-credentials: false
- uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
with:
python-version-file: '.python-version'
- uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
with:
version: '0.9.28'
enable-cache: true
- run: uv sync --locked
- name: Bind selected artifact to successful trusted release run
id: source
env:
GH_TOKEN: ${{ github.token }}
BUILD_RUN_ID: ${{ inputs.build_run_id }}
ARTIFACT_ID: ${{ inputs.artifact_id }}
ARCHIVE_SHA256: ${{ inputs.archive_sha256 }}
run: |
set -euo pipefail
uv run --locked python -m scripts.deploy.workflow_source "$BUILD_RUN_ID" "$ARTIFACT_ID" "$ARCHIVE_SHA256"
- uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
with:
artifact-ids: ${{ inputs.artifact_id }}
run-id: ${{ inputs.build_run_id }}
github-token: ${{ github.token }}
path: build/received
merge-multiple: true
- name: Verify complete unchanged archive before configuring transport
env:
APPROVED_SHA: ${{ inputs.archive_sha256 }}
TRUSTED_SHA: ${{ steps.source.outputs.trusted_sha }}
run: bash scripts/deploy/verify-artifact.sh build/received/cloudscripting-docs.tar.gz "$APPROVED_SHA" migration/release-sources.yaml build/promotion-validation.json "$TRUSTED_SHA"
- name: Deploy through confirmed backup and symlink strategy
env:
APPROVED_SHA: ${{ inputs.archive_sha256 }}
TRUSTED_SHA: ${{ steps.source.outputs.trusted_sha }}
HOST_CONFIG: ${{ secrets.DEPLOY_HOST_CONFIG }}
SSH_KEY: ${{ secrets.SSH_KEY }}
SSH_KNOWN_HOSTS: ${{ secrets.SSH_KNOWN_HOSTS }}
shell: bash
run: |
set -euo pipefail
umask 077
test -n "$HOST_CONFIG"
test -n "$SSH_KEY"
test -n "$SSH_KNOWN_HOSTS"
config=$(mktemp "$RUNNER_TEMP/cs-host.XXXXXXXX.json")
key=$(mktemp "$RUNNER_TEMP/cs-key.XXXXXXXX")
trap 'rm -f -- "$config" "$key"' EXIT
printf '%s' "$HOST_CONFIG" > "$config"
printf '%s\n' "$SSH_KEY" > "$key"
mkdir -p "$HOME/.ssh"
printf '%s\n' "$SSH_KNOWN_HOSTS" > "$HOME/.ssh/known_hosts"
eval "$(ssh-agent -s)" > /dev/null
trap 'ssh-agent -k > /dev/null; rm -f -- "$config" "$key"' EXIT
ssh-add "$key"
bash scripts/deploy/deploy-artifact.sh production build/received/cloudscripting-docs.tar.gz "$APPROVED_SHA" migration/release-sources.yaml build/promotion-validation.json "$config" "$TRUSTED_SHA" > build/deployment-receipt.json
- uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
if: always()
with:
name: production-delivery-evidence
path: |
build/promotion-validation.json
build/deployment-receipt.json
if-no-files-found: warn
95 changes: 95 additions & 0 deletions .github/workflows/deploy-staging.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
name: Deploy staging accepted artifact
on:
workflow_dispatch:
inputs:
build_run_id:
description: Successful Build complete Hugo release run ID
required: true
type: string
artifact_id:
description: Exact cloudscripting-docs-release artifact ID from that run
required: true
type: string
archive_sha256:
description: Accepted archive SHA-256 (same archive for staging and production)
required: true
type: string
permissions:
contents: read
actions: read
concurrency:
group: cloudscripting-docs-staging
cancel-in-progress: false
jobs:
deploy:
runs-on: ubuntu-24.04
environment: staging
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
fetch-depth: 0
submodules: recursive
persist-credentials: false
- uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
with:
python-version-file: '.python-version'
- uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
with:
version: '0.9.28'
enable-cache: true
- run: uv sync --locked
- name: Bind selected artifact to successful trusted release run
id: source
env:
GH_TOKEN: ${{ github.token }}
BUILD_RUN_ID: ${{ inputs.build_run_id }}
ARTIFACT_ID: ${{ inputs.artifact_id }}
ARCHIVE_SHA256: ${{ inputs.archive_sha256 }}
run: |
set -euo pipefail
uv run --locked python -m scripts.deploy.workflow_source "$BUILD_RUN_ID" "$ARTIFACT_ID" "$ARCHIVE_SHA256"
- uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
with:
artifact-ids: ${{ inputs.artifact_id }}
run-id: ${{ inputs.build_run_id }}
github-token: ${{ github.token }}
path: build/received
merge-multiple: true
- name: Verify complete unchanged archive before configuring transport
env:
APPROVED_SHA: ${{ inputs.archive_sha256 }}
TRUSTED_SHA: ${{ steps.source.outputs.trusted_sha }}
run: bash scripts/deploy/verify-artifact.sh build/received/cloudscripting-docs.tar.gz "$APPROVED_SHA" migration/release-sources.yaml build/promotion-validation.json "$TRUSTED_SHA"
- name: Deploy through confirmed backup and symlink strategy
env:
APPROVED_SHA: ${{ inputs.archive_sha256 }}
TRUSTED_SHA: ${{ steps.source.outputs.trusted_sha }}
HOST_CONFIG: ${{ secrets.DEPLOY_HOST_CONFIG }}
SSH_KEY: ${{ secrets.SSH_KEY }}
SSH_KNOWN_HOSTS: ${{ secrets.SSH_KNOWN_HOSTS }}
shell: bash
run: |
set -euo pipefail
umask 077
test -n "$HOST_CONFIG"
test -n "$SSH_KEY"
test -n "$SSH_KNOWN_HOSTS"
config=$(mktemp "$RUNNER_TEMP/cs-host.XXXXXXXX.json")
key=$(mktemp "$RUNNER_TEMP/cs-key.XXXXXXXX")
trap 'rm -f -- "$config" "$key"' EXIT
printf '%s' "$HOST_CONFIG" > "$config"
printf '%s\n' "$SSH_KEY" > "$key"
mkdir -p "$HOME/.ssh"
printf '%s\n' "$SSH_KNOWN_HOSTS" > "$HOME/.ssh/known_hosts"
eval "$(ssh-agent -s)" > /dev/null
trap 'ssh-agent -k > /dev/null; rm -f -- "$config" "$key"' EXIT
ssh-add "$key"
bash scripts/deploy/deploy-artifact.sh staging build/received/cloudscripting-docs.tar.gz "$APPROVED_SHA" migration/release-sources.yaml build/promotion-validation.json "$config" "$TRUSTED_SHA" > build/deployment-receipt.json
- uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
if: always()
with:
name: staging-delivery-evidence
path: |
build/promotion-validation.json
build/deployment-receipt.json
if-no-files-found: warn
29 changes: 29 additions & 0 deletions .github/workflows/hugo-check.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Hugo checks
on:
pull_request:
workflow_dispatch:
permissions:
contents: read
jobs:
check:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
fetch-depth: 0
submodules: recursive
persist-credentials: false
- uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
with:
python-version-file: '.python-version'
- run: bash scripts/deploy/setup-ci.sh
- uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
with:
version: '0.9.28'
enable-cache: true
- run: uv sync --locked
- name: Fixture, collision and immutable-export checks on Linux
run: uv run --locked python -m unittest discover -s tests/migration
- run: task hugo:verify
- name: Build current published content with compatibility assets
run: task build
86 changes: 0 additions & 86 deletions .github/workflows/main.yml
View file
Open in desktop

This file was deleted.

Loading
Loading