FilesExpand file tree

main

/

publish.yml

Copy path

View runs

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

246 lines (221 loc) · 8.15 KB

main

/

publish.yml

Copy path

Top

File metadata and controls

• Code
• Blame

246 lines (221 loc) · 8.15 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

name: Publish documentation

run-name: Publish source run ${{ inputs.source-run-id }} attempt ${{ inputs.source-run-attempt }}

on:

workflow_dispatch:

inputs:

source-run-id:

description: Successful msgspec/msgspec documentation workflow run ID.

required: true

type: string

source-run-attempt:

description: Latest successful attempt of that workflow run.

required: true

type: string

permissions: {}

jobs:

metadata:

name: Validate source identity and routing

runs-on: ubuntu-latest

timeout-minutes: 5

permissions:

contents: read

outputs:

target: ${{ steps.source.outputs.target }}

branch: ${{ steps.source.outputs.branch }}

source_sha: ${{ steps.source.outputs.source_sha }}

steps:

- name: Require the trusted publisher main branch

run: test "$GITHUB_REPOSITORY" = msgspec/docs-deploy && test "$GITHUB_REF" = refs/heads/main

- name: Check out trusted publisher code

uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0

with:

repository: msgspec/docs-deploy

ref: main

persist-credentials: false

- name: Set up Python

uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1

with:

python-version: '3.12'

- name: Mint a source reader token

id: reader

uses: actions/create-github-app-token@64ab729a6294000f5aa4a4bc0b73d1f32bc45510

with:

app-id: ${{ vars.DOCS_APP_ID }}

private-key: ${{ secrets.DOCS_APP_PRIVATE_KEY }}

owner: msgspec

repositories: msgspec

permission-actions: read

permission-contents: read

permission-pull-requests: read

- name: Resolve the source run and artifact

id: source

env:

SOURCE_TOKEN: ${{ steps.reader.outputs.token }}

SOURCE_RUN_ID: ${{ inputs.source-run-id }}

SOURCE_RUN_ATTEMPT: ${{ inputs.source-run-attempt }}

run: python scripts/publish.py metadata

preview:

name: Publish pull request preview

needs: metadata

if: needs.metadata.outputs.target == 'preview'

runs-on: ubuntu-latest

timeout-minutes: 20

permissions:

contents: read

environment:

name: docs-preview

deployment: false

concurrency:

group: docs-preview-${{ needs.metadata.outputs.branch }}

cancel-in-progress: true

steps:

- name: Check out trusted publisher code

uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0

with:

repository: msgspec/docs-deploy

ref: main

persist-credentials: false

- name: Set up Python

uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1

with:

python-version: '3.12'

- name: Mint a source reader token

id: reader

uses: actions/create-github-app-token@64ab729a6294000f5aa4a4bc0b73d1f32bc45510

with:

app-id: ${{ vars.DOCS_APP_ID }}

private-key: ${{ secrets.DOCS_APP_PRIVATE_KEY }}

owner: msgspec

repositories: msgspec

permission-actions: read

permission-contents: read

permission-pull-requests: read

- name: Download and validate static documentation

env:

SOURCE_TOKEN: ${{ steps.reader.outputs.token }}

SOURCE_RUN_ID: ${{ inputs.source-run-id }}

SOURCE_RUN_ATTEMPT: ${{ inputs.source-run-attempt }}

EXPECTED_TARGET: ${{ needs.metadata.outputs.target }}

EXPECTED_BRANCH: ${{ needs.metadata.outputs.branch }}

EXPECTED_SHA: ${{ needs.metadata.outputs.source_sha }}

run: python scripts/publish.py prepare

- name: Revalidate the current pull request and latest source attempt

env:

SOURCE_TOKEN: ${{ steps.reader.outputs.token }}

SOURCE_RUN_ID: ${{ inputs.source-run-id }}

SOURCE_RUN_ATTEMPT: ${{ inputs.source-run-attempt }}

run: python scripts/publish.py revalidate

- name: Publish static preview

id: deploy

uses: cloudflare/wrangler-action@ebbaa1584979971c8614a24965b4405ff95890e0

with:

apiToken: ${{ secrets.CF_PAGES_TOKEN }}

accountId: ${{ secrets.CF_ACCOUNT_ID }}

command: >-

pages deploy ${{ runner.temp }}/docs-data/site

--project-name=msgspec

--branch=${{ needs.metadata.outputs.branch }}

--commit-hash=${{ needs.metadata.outputs.source_sha }}

wranglerVersion: 4.98.0

- name: Record successful deployment

env:

PUBLISHED: 'true'

DEPLOYMENT_URL: ${{ steps.deploy.outputs.pages-deployment-alias-url }}

run: python scripts/publish.py result

- name: Upload deployment result

uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a

with:

name: docs-deployment

path: ${{ runner.temp }}/docs-data/result.json

if-no-files-found: error

retention-days: 7

overwrite: true

production:

name: Publish production and update snapshot

needs: metadata

if: needs.metadata.outputs.target == 'production'

runs-on: ubuntu-latest

timeout-minutes: 20

permissions:

contents: write

environment:

name: docs-live

deployment: false

concurrency:

group: docs-production

cancel-in-progress: false

steps:

- name: Check out trusted publisher code

uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0

with:

repository: msgspec/docs-deploy

ref: main

persist-credentials: false

- name: Check out the production snapshot as data

uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0

with:

repository: msgspec/docs-deploy

ref: cf-pages

path: snapshot

persist-credentials: false

- name: Set up Python

uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1

with:

python-version: '3.12'

- name: Mint a source reader token

id: reader

uses: actions/create-github-app-token@64ab729a6294000f5aa4a4bc0b73d1f32bc45510

with:

app-id: ${{ vars.DOCS_APP_ID }}

private-key: ${{ secrets.DOCS_APP_PRIVATE_KEY }}

owner: msgspec

repositories: msgspec

permission-actions: read

permission-contents: read

permission-pull-requests: read

- name: Download and validate static documentation

env:

SOURCE_TOKEN: ${{ steps.reader.outputs.token }}

SOURCE_RUN_ID: ${{ inputs.source-run-id }}

SOURCE_RUN_ATTEMPT: ${{ inputs.source-run-attempt }}

EXPECTED_TARGET: ${{ needs.metadata.outputs.target }}

EXPECTED_BRANCH: ${{ needs.metadata.outputs.branch }}

EXPECTED_SHA: ${{ needs.metadata.outputs.source_sha }}

run: python scripts/publish.py prepare

- name: Revalidate the source head, latest attempt, and snapshot

id: current

env:

SOURCE_TOKEN: ${{ steps.reader.outputs.token }}

SOURCE_RUN_ID: ${{ inputs.source-run-id }}

SOURCE_RUN_ATTEMPT: ${{ inputs.source-run-attempt }}

run: python scripts/publish.py revalidate

- name: Publish static production site

id: deploy

if: steps.current.outputs.publish == 'true'

uses: cloudflare/wrangler-action@ebbaa1584979971c8614a24965b4405ff95890e0

with:

apiToken: ${{ secrets.CF_PAGES_TOKEN }}

accountId: ${{ secrets.CF_ACCOUNT_ID }}

command: >-

pages deploy ${{ runner.temp }}/docs-data/site

--project-name=msgspec

--branch=cf-pages

--commit-hash=${{ needs.metadata.outputs.source_sha }}

wranglerVersion: 4.98.0

- name: Save the deployed production snapshot

if: steps.current.outputs.publish == 'true'

env:

SNAPSHOT_TOKEN: ${{ github.token }}

run: python scripts/publish.py snapshot

- name: Record successful production result

env:

PUBLISHED: ${{ steps.current.outputs.publish }}

run: python scripts/publish.py result

- name: Upload deployment result

uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a

with:

name: docs-deployment

path: ${{ runner.temp }}/docs-data/result.json

if-no-files-found: error

retention-days: 7

overwrite: true