-
Notifications
You must be signed in to change notification settings - Fork 0
268 lines (245 loc) · 11 KB
/
release-please.yml
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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
name: Release Please Action
on:
workflow_call:
inputs:
target-branch:
description: "Optional branch to target for release"
required: false
type: string
default: "dev"
default-branch:
description: "Optional default branch to target for release"
required: false
type: string
default: "main"
config-file:
description: "Optional path to the release-please configuration file"
required: false
type: string
default: "release-please-config.json"
manifest-file:
description: "Optional path to the release-please manifest file"
required: false
type: string
default: ".release-please-manifest.json"
runs-on:
description: "Optional label for the runner to run on"
required: false
type: string
default: "['self-hosted', 'Linux', 'X64']"
use-root-gitflow:
description: "Optional flag to enable gitflow release for root component"
required: false
type: boolean
default: true
use-docs-gitflow:
description: "Optional flag to enable gitflow release for docs component"
required: false
type: boolean
default: true
committer-email:
description: "Optional committer email"
required: false
type: string
default: "[email protected]"
committer-name:
description: "Optional committer name"
required: false
type: string
default: "alwyn974"
node-version:
description: "Optional node version for docs component"
required: false
type: string
default: "20.x"
secrets:
APP_ID:
description: "GitHub App ID"
required: true
APP_PRIVATE_KEY:
description: "GitHub App Private Key"
required: true
outputs:
outputs:
description: "All outputs from the release-please action as JSON"
value: ${{ jobs.release-please.outputs.outputs }}
# https://github.com/googleapis/release-please-action?tab=readme-ov-file#outputs
releases_created:
description: "Boolean indicating if releases were created"
value: ${{ jobs.release-please.outputs.releases_created }}
paths_released:
description: "A JSON string of the array of paths that had releases created ([] if )"
value: ${{ jobs.release-please.outputs.paths_released }}
prs_created:
description: "Boolean if any pull request was created or updated"
value: ${{ jobs.release-please.outputs.prs_created }}
pr:
description: "A JSON string of the PullRequest object (unset if no release created) https://github.com/googleapis/release-please/blob/main/src/pull-request.ts#L15"
value: ${{ jobs.release-please.outputs.pr }}
prs:
description: "A JSON string of the array of PullRequest objects (unset if no release created) https://github.com/googleapis/release-please/blob/main/src/pull-request.ts#L15"
value: ${{ jobs.release-please.outputs.prs }}
# https://github.com/googleapis/release-please-action?tab=readme-ov-file#root-component-outputs
release_created:
description: "Boolean if a root component release was created, false otherwise"
value: ${{ jobs.release-please.outputs.release_created }}
upload_url:
description: "Directly related to Create a release API https://developer.github.com/v3/repos/releases/#response-4"
value: ${{ jobs.release-please.outputs.upload_url }}
html_url:
description: "Directly related to Create a release API https://developer.github.com/v3/repos/releases/#response-4"
value: ${{ jobs.release-please.outputs.html_url }}
tag_name:
description: "Directly related to Create a release API https://developer.github.com/v3/repos/releases/#response-4"
value: ${{ jobs.release-please.outputs.tag_name }}
version:
description: "Version number (major.minor.patch) of the release created"
value: ${{ jobs.release-please.outputs.version }}
major:
description: "Major version number"
value: ${{ jobs.release-please.outputs.major }}
minor:
description: "Minor version number"
value: ${{ jobs.release-please.outputs.minor }}
patch:
description: "Patch version number"
value: ${{ jobs.release-please.outputs.patch }}
sha:
description: "SHA of the commit that was released"
value: ${{ jobs.release-please.outputs.sha }}
jobs:
release-please:
name: Run Release Please
permissions:
contents: write # to create release commit (google-github-actions/release-please-action)
pull-requests: write # to create release PR (google-github-actions/release-please-action)
runs-on: ${{ fromJSON(inputs.runs-on) }}
outputs:
outputs: ${{ toJson(steps.release-please.outputs) }}
releases_created: ${{ steps.release-please.outputs.releases_created }}
paths_released: ${{ steps.release-please.outputs.paths_released }}
prs_created: ${{ steps.release-please.outputs.prs_created }}
pr: ${{ steps.release-please.outputs.pr }}
prs: ${{ steps.release-please.outputs.prs }}
# only with root component "."
release_created: ${{ steps.release-please.outputs.release_created }}
upload_url: ${{ steps.release-please.outputs.upload_url }}
html_url: ${{ steps.release-please.outputs.html_url }}
tag_name: ${{ steps.release-please.outputs.tag_name }}
# Doesn't exist in docs ? But works
version: ${{ steps.release-please.outputs.version }}
major: ${{ steps.release-please.outputs.major }}
minor: ${{ steps.release-please.outputs.minor }}
patch: ${{ steps.release-please.outputs.patch }}
sha: ${{ steps.release-please.outputs.sha }}
steps:
- name: Generate token
uses: tibdex/github-app-token@3beb63f4bd073e61482598c45c71c1019b59b73a # ratchet:tibdex/github-app-token@v2
id: generate-token
with:
app_id: ${{ secrets.APP_ID }}
private_key: ${{ secrets.APP_PRIVATE_KEY }}
- name: Release Please
uses: googleapis/release-please-action@7987652d64b4581673a76e33ad5e98e3dd56832f # v4
id: release-please
with:
token: ${{ steps.generate-token.outputs.token }}
config-file: ${{ inputs.config-file }}
manifest-file: ${{ inputs.manifest-file }}
target-branch: ${{ inputs.target-branch }}
root-gitflow-release:
name: Gitflow release - Root
needs: release-please
if: ${{ needs.release-please.outputs.release_created == 'true' && inputs.use-root-gitflow == true }}
runs-on: ${{ fromJSON(inputs.runs-on) }}
permissions:
contents: write
steps:
- name: Generate token
uses: tibdex/github-app-token@3beb63f4bd073e61482598c45c71c1019b59b73a # ratchet:tibdex/github-app-token@v2
id: generate-token
with:
app_id: ${{ secrets.APP_ID }}
private_key: ${{ secrets.APP_PRIVATE_KEY }}
- name: Checkout code
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
with:
fetch-depth: 0
token: ${{ steps.generate-token.outputs.token }}
- name: Release root component
env:
release_version: ${{ needs.release-please.outputs.tag_name }}
version: ${{ needs.release-please.outputs.version }}
NEXT_BRANCH: ${{ inputs.target-branch }}
DEFAULT_BRANCH: ${{ inputs.default-branch }}
run: |
git config --global user.name ${{ inputs.committer-name }}
git config --global user.email ${{ inputs.committer-email }}
# Create new release branch (e.g release/docs-v1.0.0, release/v1.0.0) from NEXT_BRANCH (e.g dev)
git checkout -b release/${{ env.release_version }} ${{ env.NEXT_BRANCH }}
# Merge release branch into the default branch (e.g main)
git checkout ${{ env.DEFAULT_BRANCH }}
git merge --no-ff release/${{ env.release_version }}
# git tag --delete ${{ env.release_version }} # remove release please tag
# git tag -a ${{ env.release_version }} -m "Tagging version ${{ env.release_version }}" # create new tag on default branch
git checkout ${{ env.NEXT_BRANCH }}
git merge --no-ff ${{ env.release_version }}
git branch -d release/${{ env.release_version }}
git merge --no-ff ${{ env.DEFAULT_BRANCH }} # merge main into dev
git push --all && git push --tags
docs-gitflow-release:
name: Gitflow release - Docs
needs: release-please
if: ${{ fromJSON(needs.release-please.outputs.outputs)['docs--release_created'] == 'true' && inputs.use-docs-gitflow == true }}
runs-on: ${{ fromJSON(inputs.runs-on) }}
permissions:
contents: write
env:
# For writing shorter lines
outputs: ${{ needs.release-please.outputs.outputs }}
node-version: ${{ inputs.node-version }}
steps:
- name: Generate token
uses: tibdex/github-app-token@3beb63f4bd073e61482598c45c71c1019b59b73a # ratchet:tibdex/github-app-token@v2
id: generate-token
with:
app_id: ${{ secrets.APP_ID }}
private_key: ${{ secrets.APP_PRIVATE_KEY }}
- name: Checkout code
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
with:
fetch-depth: 0
token: ${{ steps.generate-token.outputs.token }}
- name: Install pnpm
uses: pnpm/action-setup@fe02b34f77f8bc703788d5817da081398fad5dd2 # ratchet:pnpm/action-setup@v4
with:
run_install: false
- name: Setup Node.js ${{ env.node-version }}
uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4
with:
node-version: ${{ env.node-version }}
cache: 'pnpm'
- name: Install dependencies
working-directory: docs
run: |
pnpm install
- name: Release - Docs component
env:
release_version: ${{ fromJSON(env.outputs)['docs--tag_name'] }}
version: ${{ fromJSON(env.outputs)['docs--version'] }}
NEXT_BRANCH: ${{ inputs.target-branch }}
DEFAULT_BRANCH: ${{ inputs.default-branch }}
run: |
git config --global user.name ${{ inputs.committer-name }}
git config --global user.email ${{ inputs.committer-email }}
git checkout -b release/${{ env.release_version }} ${{ env.NEXT_BRANCH }}
cd docs && pnpm docusaurus docs:version v${{ env.version }} && cd ..
git add docs
git commit -m "docs(release): 🚀 Release docs version ${{ env.release_version }}"
git checkout ${{ env.DEFAULT_BRANCH }}
git merge --no-ff release/${{ env.release_version }}
git checkout ${{ env.NEXT_BRANCH }}
# git merge --no-ff ${{ env.release_version }}
git branch -d release/${{ env.release_version }}
git merge --no-ff ${{ env.DEFAULT_BRANCH }} # merge main into dev
git push --all && git push --tags