mirror of
https://github.com/nix-community/nixvim.git
synced 2025-08-04 10:06:13 +02:00
ci/docs: rename workflow
This commit is contained in:
parent
2b2b1e6d8f
commit
91ecff36b6
1 changed files with 0 additions and 0 deletions
140
.github/workflows/website.yml
vendored
Normal file
140
.github/workflows/website.yml
vendored
Normal file
|
@ -0,0 +1,140 @@
|
|||
name: Build and deploy documentation
|
||||
|
||||
on:
|
||||
push:
|
||||
# Runs on pushes targeting the release branches
|
||||
branches:
|
||||
- main
|
||||
|
||||
# Allows you to run this workflow manually from the Actions tab
|
||||
workflow_dispatch:
|
||||
|
||||
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
|
||||
permissions:
|
||||
contents: read
|
||||
pages: write
|
||||
id-token: write
|
||||
|
||||
# Allow one concurrent deployment
|
||||
concurrency:
|
||||
group: "pages"
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
if: github.repository == 'nix-community/nixvim'
|
||||
environment:
|
||||
name: github-pages
|
||||
url: ${{ steps.deployment.outputs.page_url }}
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 40
|
||||
|
||||
env:
|
||||
repo: ${{ github.repository }}
|
||||
repoName: ${{ github.event.repository.name }}
|
||||
out: docs-build
|
||||
|
||||
steps:
|
||||
- name: Install nix
|
||||
uses: cachix/install-nix-action@v31
|
||||
with:
|
||||
nix_path: nixpkgs=channel:nixos-unstable
|
||||
|
||||
- name: Configure cachix
|
||||
uses: cachix/cachix-action@v16
|
||||
with:
|
||||
name: nix-community
|
||||
authToken: "${{ secrets.CACHIX_AUTH_TOKEN }}"
|
||||
|
||||
- name: Build docs
|
||||
run: |
|
||||
set -ex
|
||||
|
||||
# A list of all doc versions to be built,
|
||||
# (Written to versions.json)
|
||||
echo '
|
||||
[
|
||||
{
|
||||
"branch": "main",
|
||||
"nixpkgsBranch": "nixos-unstable"
|
||||
},
|
||||
{
|
||||
"branch": "nixos-25.05",
|
||||
"nixpkgsBranch": "nixos-25.05",
|
||||
"subPath": "25.05"
|
||||
},
|
||||
{
|
||||
"branch": "nixos-24.11",
|
||||
"nixpkgsBranch": "nixos-24.11",
|
||||
"subPath": "24.11"
|
||||
}
|
||||
]
|
||||
' | jq \
|
||||
--arg repoName "$repoName" \
|
||||
'map(
|
||||
.
|
||||
# Ensure subPath is a string
|
||||
| .subPath = (.subPath // "")
|
||||
# Construct baseHref from $repoName and .subPath
|
||||
| .baseHref = (
|
||||
.subPath
|
||||
| if . == "" then "" else "/\(.)" end
|
||||
| $repoName + .
|
||||
| "/\(.)/"
|
||||
)
|
||||
)' > versions.json
|
||||
|
||||
# 1: branch
|
||||
# 2: baseHref
|
||||
# 3: install dir
|
||||
build() {
|
||||
flakeref="github:${repo}${1:+/$1}"
|
||||
baseHref="$2"
|
||||
installDir="${out}${3:+/$3}"
|
||||
|
||||
# Build docs for the given flake ref, overriding the relevant derivation args
|
||||
nix build --impure \
|
||||
--argstr flakeref "$flakeref" \
|
||||
--argstr baseHref "$baseHref" \
|
||||
--arg-from-file versionsJson versions.json \
|
||||
--expr '
|
||||
{
|
||||
flakeref,
|
||||
baseHref,
|
||||
versionsJson,
|
||||
system ? builtins.currentSystem,
|
||||
}:
|
||||
let
|
||||
flake = builtins.getFlake flakeref;
|
||||
packages = flake.outputs.packages.${system};
|
||||
in
|
||||
packages.docs.override {
|
||||
inherit baseHref;
|
||||
availableVersions = builtins.fromJSON versionsJson;
|
||||
}
|
||||
'
|
||||
|
||||
# Copy the result to the install dir
|
||||
mkdir -p "$installDir"
|
||||
cp -r result/* "$installDir"
|
||||
}
|
||||
|
||||
# For each version of the docs...
|
||||
jq -c '.[]' versions.json |
|
||||
while IFS=$"\n" read -r entry; do
|
||||
branch=$(echo "$entry" | jq -r '.branch')
|
||||
baseHref=$(echo "$entry" | jq -r '.baseHref')
|
||||
installDir=$(echo "$entry" | jq -r '.subPath')
|
||||
|
||||
# Build this version of the docs
|
||||
build "$branch" "$baseHref" "$installDir"
|
||||
done
|
||||
|
||||
- name: Upload artifact
|
||||
uses: actions/upload-pages-artifact@v3
|
||||
with:
|
||||
path: "docs-build"
|
||||
|
||||
- name: Deploy to GitHub Pages
|
||||
id: deployment
|
||||
uses: actions/deploy-pages@v4
|
Loading…
Add table
Add a link
Reference in a new issue