blob: f5529aa644340466e8b057295af3db44eba22028 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
name: Build and Preview Manual
on:
workflow_dispatch:
pull_request_target:
types: [opened, synchronize, reopened, labeled, unlabeled, edited]
paths:
- ".github/workflows/docs-preview.yml"
- "modules/**"
- "docs/**"
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
build-preview:
runs-on: ubuntu-latest
# NOTE: This job runs untrusted code.
# Don't give it any permissions.
permissions: {}
steps:
- uses: actions/checkout@v7
with:
ref: ${{ github.event.pull_request.head.sha }}
persist-credentials: false
# NOTE: Only doing this, because we set `permissions: {}`
# to ensure, no secrets can leak here.
allow-unsafe-pr-checkout: true
- uses: cachix/install-nix-action@v31.11.1
with:
nix_path: nixpkgs=channel:nixos-unstable
extra_nix_config: |
substituters = https://cache.nixos.org/ https://feel-co.cachix.org
trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= feel-co.cachix.org-1:nwEFNnwZvtl4KKSH5LDg+/+K7bV0vcs6faMHAJ6xx0w=
- uses: cachix/cachix-action@v17
with:
authToken: ${{ secrets.CACHIX_TOKEN }}
extraPullNames: nix-community
name: nvf
- name: Set default git branch (to reduce log spam)
run: git config --global init.defaultBranch main
- name: Build documentation packages
run: nix build .#docs-html --print-build-logs || exit 1
- name: Upload built docs
uses: actions/upload-artifact@v7
with:
name: docs-html
path: result/share/doc/
retention-days: 1
deploy-preview:
needs: build-preview
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Download built docs
uses: actions/download-artifact@v8
with:
name: docs-html
path: built-docs
- name: Deploy to GitHub Pages preview
run: |
PR_NUMBER=${{ github.event.pull_request.number }}
BRANCH_NAME="gh-pages"
PREVIEW_DIR="docs-preview-${PR_NUMBER}"
# Clone the gh-pages branch and move to the preview subdirectory
git clone --single-branch --branch $BRANCH_NAME https://github.com/${{ github.repository }} gh-pages
cd gh-pages
mkdir -p $PREVIEW_DIR
# Copy the build files to the preview subdirectory
cp -rvf ../built-docs/* ./$PREVIEW_DIR
# Configure git to use the GitHub Actions token for authentication
git config --global user.name "GitHub Actions"
git config --global user.email "actions@github.com"
# Set the GitHub token for authentication
git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
# Add and commit the changes
git add --all
git commit -m "Deploy PR #${PR_NUMBER} preview" || echo "No changes to commit"
git push --force origin $BRANCH_NAME
comment:
needs: deploy-preview
runs-on: ubuntu-latest
permissions:
pull-requests: write
steps:
- name: Prepare Environment
id: prelude
run: |
PR_NUMBER=${{ github.event.pull_request.number }}
URL="https:///nvf.notashelf.dev/docs-preview-${PR_NUMBER}/"
# Propagate non-interpolatable environment vars
echo "URL=$URL" >> "$GITHUB_OUTPUT"
echo "REV=$GITHUB_SHA" >> "$GITHUB_OUTPUT"
echo "ACTOR=$GITHUB_ACTOR" >> "$GITHUB_OUTPUT"
echo "REF=$GITHUB_HEAD_REF" >> "$GITHUB_OUTPUT"
echo "RUNS=$GITHUB_RUN_NUMBER" >> "$GITHUB_OUTPUT"
echo "Live Preview URL: $URL"
echo "Rev: $GITHUB_SHA"
echo "Actor: $GITHUB_ACTOR"
echo "Ref: "$GITHUB_HEAD_REF"
echo "Reruns: "$GITHUB_RUN_NUMBER"
echo "### :rocket: Live Preview Deployed " >> "$GITHUB_STEP_SUMMARY"
echo "Preview can be found at ${URL}" >> "$GITHUB_STEP_SUMMARY"
- name: Find Comment
uses: peter-evans/find-comment@v4
id: fc
with:
comment-author: "github-actions[bot]"
issue-number: ${{ github.event.pull_request.number }}
body-includes: "Live preview deployed"
- name: Post live preview comment
uses: peter-evans/create-or-update-comment@v5
env:
COMMENT_ID: ${{ steps.fc.outputs.comment-id }}
URL: ${{ steps.prelude.outputs.URL }}
GITHUB_SHA: ${{ steps.prelude.outputs.REV }}
ACTOR: ${{ steps.prelude.outputs.ACTOR }}
REF: ${{ steps.prelude.outputs.REF }}
RUNS: ${{ steps.prelude.outputs.RUNS }}
with:
comment-id: ${{ env.COMMENT_ID }}
issue-number: ${{ github.event.pull_request.number }} # issue number also applies to pull requests
edit-mode: replace # replace previous body
body: |
### :rocket: Live preview deployed from ${{ env.GITHUB_SHA }}
View it [here](${{ env.URL }}):
<details>
<summary><strong>Debug Information</strong></summary>
<p>Triggered by: ${{ env.ACTOR }}</p>
<p><code>HEAD</code> at: ${{ env.REF }}</p>
<p>Reruns: ${{ env.RUNS }}</p>
</details>
cleanup-preview:
if: ${{ github.event.pull_request.merged == true || github.event.pull_request.state == 'closed' }}
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout repository
uses: actions/checkout@v7
- name: Delete preview for closed/merged PR
run: |
PR_NUMBER=${{ github.event.pull_request.number }}
BRANCH_NAME="gh-pages"
PREVIEW_DIR="docs-preview-${PR_NUMBER}"
# Clone the gh-pages branch
git clone --single-branch --branch $BRANCH_NAME https://github.com/${{ github.repository }} gh-pages
cd gh-pages
# Check if the preview directory exists, and delete it if it does
if [ -d "$PREVIEW_DIR" ]; then
echo "Deleting preview directory $PREVIEW_DIR"
rm -rf $PREVIEW_DIR
else
echo "Preview directory $PREVIEW_DIR does not exist. Skipping deletion."
fi
# Configure git to use the GitHub Actions token for authentication
git config --global user.name "GitHub Actions"
git config --global user.email "actions@github.com"
# Set the GitHub token for authentication
git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
# Add and commit the changes (only if there's something to delete)
git add .
git diff --quiet || git commit -m "Remove preview for PR #${PR_NUMBER}"
git push origin $BRANCH_NAME
cleanup-comment:
needs: cleanup-preview
runs-on: ubuntu-latest
permissions:
pull-requests: write
steps:
- name: Checkout repository
uses: actions/checkout@v7
- name: Double check preview directory deletion
run: |
# Check if the preview directory exists, and delete it if it does
if [ -d "docs-preview-${{ github.event.pull_request.number }}" ]; then
echo "Something went wrong, preview directory is not deleted."
exit 1
else
echo "Preview directory has been deleted successfully, proceeding."
fi
- name: Post cleanup verification
uses: peter-evans/create-or-update-comment@v5
with:
issue-number: ${{ github.event.pull_request.number }}
body: |
✅ Preview has been deleted successfully!
|
