Skip to content

Commit 545e28f

Browse files
webstackdevwebstackdev
committed
Fix to deployment workflow for Vercel to report to GitHub
1 parent cf16c11 commit 545e28f

3 files changed

Lines changed: 190 additions & 43 deletions

File tree

‎.github/workflows/deployment.yml‎

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,33 @@ jobs:
7171
with:
7272
ref: ${{ github.event.workflow_run.head_sha }}
7373

74+
- name: Create GitHub deployment (Preview)
75+
if: ${{ !startsWith(github.event.workflow_run.head_branch, 'hotfix/') }}
76+
id: github-deployment-preview
77+
uses: actions/github-script@v8
78+
with:
79+
script: |
80+
const workflowRun = context.payload.workflow_run;
81+
const ref = workflowRun?.head_sha;
82+
if (!ref) {
83+
core.setFailed('Missing workflow_run.head_sha; cannot create GitHub deployment.');
84+
return;
85+
}
86+
87+
const { data } = await github.rest.repos.createDeployment({
88+
owner: context.repo.owner,
89+
repo: context.repo.repo,
90+
ref,
91+
auto_merge: false,
92+
required_contexts: [],
93+
environment: 'vercel-preview',
94+
transient_environment: true,
95+
production_environment: false,
96+
description: 'Vercel preview deployment'
97+
});
98+
99+
core.setOutput('deployment_id', String(data.id));
100+
74101
- name: Deploy to Vercel (Preview)
75102
if: ${{ !startsWith(github.event.workflow_run.head_branch, 'hotfix/') }}
76103
uses: amondnet/vercel-action@v41.1.4
@@ -86,6 +113,78 @@ jobs:
86113
GITHUB_SHA: ${{ github.event.workflow_run.head_sha }}
87114
GITHUB_REF: refs/heads/${{ github.event.workflow_run.head_branch }}
88115

116+
- name: Update GitHub deployment status (Preview)
117+
if: ${{ !startsWith(github.event.workflow_run.head_branch, 'hotfix/') && always() }}
118+
uses: actions/github-script@v8
119+
env:
120+
VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
121+
VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
122+
VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
123+
with:
124+
script: |
125+
const deploymentIdRaw = '${{ steps.github-deployment-preview.outputs.deployment_id }}';
126+
const deploymentId = Number(deploymentIdRaw);
127+
if (!deploymentIdRaw || Number.isNaN(deploymentId)) {
128+
core.warning('Missing deployment id; skipping GitHub deployment status update.');
129+
return;
130+
}
131+
132+
const workflowRun = context.payload.workflow_run;
133+
const rawPreviewUrl = '${{ steps.vercel-preview.outputs.preview-url }}'.trim();
134+
const isVercelUrl = (url) => typeof url === 'string' && /vercel\.(app|com)/.test(url);
135+
const fallbackRunUrl = `https://github.com/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}`;
136+
137+
const fetchDeploymentUrl = async () => {
138+
if (!process.env.VERCEL_TOKEN || !process.env.VERCEL_PROJECT_ID) {
139+
return null;
140+
}
141+
if (typeof fetch !== 'function') {
142+
return null;
143+
}
144+
const query = new URLSearchParams({
145+
projectId: process.env.VERCEL_PROJECT_ID,
146+
'meta-githubCommitSha': workflowRun?.head_sha ?? '',
147+
limit: '1'
148+
});
149+
if (process.env.VERCEL_ORG_ID) {
150+
query.set('teamId', process.env.VERCEL_ORG_ID);
151+
}
152+
const response = await fetch(`https://api.vercel.com/v6/deployments?${query.toString()}`, {
153+
headers: {
154+
Authorization: `Bearer ${process.env.VERCEL_TOKEN}`
155+
}
156+
});
157+
if (!response.ok) {
158+
return null;
159+
}
160+
const data = await response.json();
161+
const deployment = data?.deployments?.[0];
162+
if (deployment?.url) {
163+
return `https://${deployment.url}`;
164+
}
165+
if (deployment?.inspectorUrl) {
166+
return deployment.inspectorUrl.startsWith('http')
167+
? deployment.inspectorUrl
168+
: `https://${deployment.inspectorUrl}`;
169+
}
170+
return null;
171+
};
172+
173+
const previewUrl = isVercelUrl(rawPreviewUrl) ? rawPreviewUrl : await fetchDeploymentUrl();
174+
const state = '${{ steps.vercel-preview.outcome }}' === 'success' ? 'success' : 'failure';
175+
const targetUrl = isVercelUrl(previewUrl) ? previewUrl : fallbackRunUrl;
176+
177+
await github.rest.repos.createDeploymentStatus({
178+
owner: context.repo.owner,
179+
repo: context.repo.repo,
180+
deployment_id: deploymentId,
181+
state,
182+
environment: 'vercel-preview',
183+
environment_url: targetUrl,
184+
log_url: fallbackRunUrl,
185+
description: state === 'success' ? 'Vercel preview is ready' : 'Vercel preview failed'
186+
});
187+
89188
- name: Comment preview URL on PR
90189
if: ${{ !startsWith(github.event.workflow_run.head_branch, 'hotfix/') && always() && steps.vercel-preview.outcome == 'success' }}
91190
uses: actions/github-script@v8
@@ -290,6 +389,32 @@ jobs:
290389
with:
291390
ref: ${{ github.event.workflow_run.head_sha }}
292391

392+
- name: Create GitHub deployment (Production)
393+
id: github-deployment-production
394+
uses: actions/github-script@v8
395+
with:
396+
script: |
397+
const workflowRun = context.payload.workflow_run;
398+
const ref = workflowRun?.head_sha;
399+
if (!ref) {
400+
core.setFailed('Missing workflow_run.head_sha; cannot create GitHub deployment.');
401+
return;
402+
}
403+
404+
const { data } = await github.rest.repos.createDeployment({
405+
owner: context.repo.owner,
406+
repo: context.repo.repo,
407+
ref,
408+
auto_merge: false,
409+
required_contexts: [],
410+
environment: 'production',
411+
transient_environment: false,
412+
production_environment: true,
413+
description: 'Vercel production deployment'
414+
});
415+
416+
core.setOutput('deployment_id', String(data.id));
417+
293418
- name: Deploy to Vercel (Production)
294419
uses: amondnet/vercel-action@v41.1.4
295420
id: vercel-production
@@ -304,6 +429,34 @@ jobs:
304429
GITHUB_SHA: ${{ github.event.workflow_run.head_sha }}
305430
GITHUB_REF: refs/heads/${{ github.event.workflow_run.head_branch }}
306431

432+
- name: Update GitHub deployment status (Production)
433+
if: ${{ always() }}
434+
uses: actions/github-script@v8
435+
with:
436+
script: |
437+
const deploymentIdRaw = '${{ steps.github-deployment-production.outputs.deployment_id }}';
438+
const deploymentId = Number(deploymentIdRaw);
439+
if (!deploymentIdRaw || Number.isNaN(deploymentId)) {
440+
core.warning('Missing deployment id; skipping GitHub deployment status update.');
441+
return;
442+
}
443+
444+
const state = '${{ steps.vercel-production.outcome }}' === 'success' ? 'success' : 'failure';
445+
const rawUrl = '${{ steps.vercel-production.outputs.preview-url }}'.trim();
446+
const environmentUrl = rawUrl ? rawUrl : undefined;
447+
const logUrl = `https://github.com/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}`;
448+
449+
await github.rest.repos.createDeploymentStatus({
450+
owner: context.repo.owner,
451+
repo: context.repo.repo,
452+
deployment_id: deploymentId,
453+
state,
454+
environment: 'production',
455+
environment_url: environmentUrl,
456+
log_url: logUrl,
457+
description: state === 'success' ? 'Production deploy completed' : 'Production deploy failed'
458+
});
459+
307460
- name: Log production deployment
308461
if: always() && steps.vercel-production.outcome == 'success'
309462
run: |

‎_TODO.md‎

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ Adds some custom directives:
207207
Allows any Mastodon instance to discover your Mastodon profile directly from your own domain.
208208

209209

210-
## Refactor social neworks in Authors collection to Contact collection format
210+
## Refactor social networks in Authors collection to Contact collection format
211211

212212
The contact data collection uses an array of social networks, with keys:
213213

@@ -222,15 +222,6 @@ The contact data collection uses an array of social networks, with keys:
222222

223223
The authors collection is using named entries under a "social" property, like "twitter", "github", etc. This task is to refactor that to use an array like contact data collection. We also need to add a color for the social network icon, or some other approach to setting the color of it while enabling theming.
224224

225-
## Preload fonts:
226-
227-
```html
228-
<link rel="preload" as="font" />
229-
```
230-
231-
TTI (Time to Interactive) measures time from when the page is painted until it becomes usefully interactive.
232-
Interactive can only have two in-flight network requests.
233-
234225
## Stuff from ZMarkdown, a prepackaged Unified config
235226

236227
Repo is in root of Corporate Websites

‎src/content.config.ts‎

Lines changed: 36 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -22,28 +22,30 @@ import { withBreadcrumbTitleWarning } from '@lib/helpers/breadcrumbTitleLengthRe
2222
/** Only load markdown and MDX files that do not start with an underscore */
2323
const pattern = '**\/[^_]*.{md,mdx}'
2424

25-
const tagContentDir = fileURLToPath(new URL('./content/tags', import.meta.url))
26-
const tagSlugs = readdirSync(tagContentDir, { withFileTypes: true })
27-
.filter(entry => entry.isDirectory() && !entry.name.startsWith('_'))
28-
.filter(entry => {
29-
const indexMd = new URL(`./content/tags/${entry.name}/index.md`, import.meta.url)
30-
const indexMdx = new URL(`./content/tags/${entry.name}/index.mdx`, import.meta.url)
31-
return fsExists(indexMd) || fsExists(indexMdx)
32-
})
33-
.map(entry => entry.name)
34-
.sort((a, b) => a.localeCompare(b, 'en'))
35-
36-
if (tagSlugs.length === 0) {
37-
throw new Error('No tags found. Add markdown files under src/content/tags.')
25+
function fsExists(url: URL) {
26+
return existsSync(fileURLToPath(url))
3827
}
3928

40-
type ZodEnumType = [string, ...string[]]
41-
const validTags = tagSlugs as ZodEnumType
29+
const getValidTags = () => {
30+
const tagContentDir = fileURLToPath(new URL('./content/tags', import.meta.url))
31+
const tagSlugs = readdirSync(tagContentDir, { withFileTypes: true })
32+
.filter(entry => entry.isDirectory() && !entry.name.startsWith('_'))
33+
.filter(entry => {
34+
const indexMd = new URL(`./content/tags/${entry.name}/index.md`, import.meta.url)
35+
const indexMdx = new URL(`./content/tags/${entry.name}/index.mdx`, import.meta.url)
36+
return fsExists(indexMd) || fsExists(indexMdx)
37+
})
38+
.map(entry => entry.name)
39+
.sort((a, b) => a.localeCompare(b, 'en'))
4240

43-
function fsExists(url: URL) {
44-
return existsSync(fileURLToPath(url))
41+
if (tagSlugs.length === 0) {
42+
throw new Error('No tags found. Add markdown files under src/content/tags.')
43+
}
44+
return tagSlugs as [string, ...string[]]
4545
}
4646

47+
const validTags = getValidTags()
48+
4749
const createBaseCollectionSchema = ({ image }: SchemaContext) =>
4850
z.object({
4951
title: z.string(),
@@ -144,22 +146,6 @@ const downloadsCollection = defineCollection({
144146
* =================================================================================
145147
*/
146148

147-
/**
148-
* Tags
149-
*/
150-
const tagsCollection = defineCollection({
151-
loader: glob({ pattern: '**/index.{md,mdx}', base: './src/content/tags' }),
152-
schema: ({ image }) =>
153-
z.object({
154-
slug: z.string(),
155-
displayName: z.string(),
156-
description: z.string(),
157-
cover: image(),
158-
coverAlt: z.string(),
159-
featured: z.boolean().default(false),
160-
}),
161-
})
162-
163149
/**
164150
* About
165151
*/
@@ -227,6 +213,23 @@ const contactDataCollection = defineCollection({
227213
}),
228214
})
229215

216+
217+
/**
218+
* Tags
219+
*/
220+
const tagsCollection = defineCollection({
221+
loader: glob({ pattern: '**/index.{md,mdx}', base: './src/content/tags' }),
222+
schema: ({ image }) =>
223+
z.object({
224+
slug: z.string(),
225+
displayName: z.string(),
226+
description: z.string(),
227+
cover: image(),
228+
coverAlt: z.string(),
229+
featured: z.boolean().default(false),
230+
}),
231+
})
232+
230233
/**
231234
* Testimonials. These do not have pages generated for them.
232235
*/

0 commit comments

Comments
 (0)