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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
|
# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
# Note: This workflow requires some secrets setup, and set on this repo with the names:
# 'FERDIUM_PUBLISH_TOKEN' (A GitHub Personal Access Token with appropriate permissions - for publishing the built artifacts)
# 'APPLEID' (The username of your Apple developer account - for notarizing the mac artifacts)
# 'APPLEID_PASSWORD' (An app-specific password - for notarizing the mac artifacts)
# 'CSC_LINK' (The HTTPS link or local path to certificate - for code signing of mac artifacts)
# 'CSC_KEY_PASSWORD' (The password to decrypt the certificate given in CSC_LINK - for code signing of mac artifacts)
# 'WIN_CSC_LINK' (The HTTPS link or local path to certificate - for code signing of windows artifacts)
# 'WIN_CSC_KEY_PASSWORD' (The password to decrypt the certificate given in CSC_LINK - for code signing of windows artifacts)
name: Builds
on:
# Push to any tracked branches
push:
branches: [develop, release, nightly]
# PRs only on develop branch
pull_request:
branches: [develop]
# Manual trigger from the UI
workflow_dispatch:
inputs:
message:
description: 'Message for build'
required: true
schedule:
- cron: '0 0 * * *' # every night at 12 am
env:
USE_HARD_LINKS: false
# DEBUG: electron-builder
jobs:
check_updates:
runs-on: ubuntu-22.04
name: 'Check latest commit: ${{ github.event.inputs.message }}'
outputs:
should_run: ${{ steps.should_run.outputs.should_run }}
steps:
- name: Checkout code along with submodules for the 'nightly' branch if the trigger event is 'scheduled'
uses: actions/checkout@v4
if: ${{ github.event_name == 'schedule' || (github.event_name == 'workflow_dispatch' && contains(github.event.inputs.message, '[nightly branch]')) }}
with:
ref: nightly
submodules: recursive
fetch-depth: 0 # Note: Needed to be able to pull the 'develop' branch as well for merging
- name: Install pnpm
uses: pnpm/action-setup@v3
if: ${{ github.event_name == 'schedule' || (github.event_name == 'workflow_dispatch' && contains(github.event.inputs.message, '[nightly branch]')) }}
- name: Use Node.js specified in the '.nvmrc' file
uses: actions/setup-node@v4
if: ${{ github.event_name == 'schedule' || (github.event_name == 'workflow_dispatch' && contains(github.event.inputs.message, '[nightly branch]')) }}
with:
node-version-file: '.nvmrc'
cache: 'pnpm'
- name: Install node dependencies
if: ${{ github.event_name == 'schedule' || (github.event_name == 'workflow_dispatch' && contains(github.event.inputs.message, '[nightly branch]')) }}
uses: nick-fields/retry@v3
with:
command: pnpm i
timeout_minutes: 15
max_attempts: 3
retry_on: error
- id: should_run
name: Check whether there are any commits since this run was last triggered and push them and/or set the output
if: ${{ github.event_name == 'schedule' || (github.event_name == 'workflow_dispatch' && contains(github.event.inputs.message, '[nightly branch]')) }}
run: |
git config user.name github-actions
git config user.email github-actions@github.com
# Defensive: update submodules in the develop branch
git checkout develop
git submodule update --init --recursive --remote --rebase --force
git add .
git commit -am "Update submodules [skip ci]" --no-verify || true
git push origin develop --no-verify
git checkout -
git rebase develop
CHANGES_COUNT=$(git log @{u}.. | wc -l)
MANUAL_REBUILD="${{ github.event_name == 'workflow_dispatch' }}"
VERSION_BUMP="${{ contains(github.event.inputs.message, '[version bump]') }}"
# If there were any changes only in the submodules, then...
if [ $CHANGES_COUNT -gt 0 ]; then
git checkout develop
echo "Update browserslist db"
npx browserslist@latest --update-db
git add .
echo "Run linter, reformatter, rebrander and tests"
pnpm prepare-code
pnpm test
echo "Commit dependency-updates and linter changes"
git commit -am "Update browserslist data updates and linter fixes [skip ci]" --no-verify || true
echo "Push all changes"
git push origin develop --no-verify
git checkout nightly
fi
if [ $CHANGES_COUNT -gt 0 ] || [[ $MANUAL_REBUILD == "true" && $VERSION_BUMP == "true" ]]; then
# Do the version bump in the 'develop' branch ONLY if
# there were other changes coming from the 'develop' branch (or)
# this is a manual trigger with the key-phrase
git checkout develop
pnpm version -m "%s [skip ci]" prerelease --preid=nightly
git commit --all --amend --no-edit --no-verify
git push origin develop --no-verify
git checkout nightly
fi
echo "Merge with fast-forward from 'origin/develop'"
git merge --ff-only origin/develop --no-verify
echo "Number of changes: $CHANGES_COUNT"
if [ $CHANGES_COUNT -eq 0 ] && [ $MANUAL_REBUILD != "true" ]; then
echo "No changes found - terminating the build"
echo "should_run=false" >> $GITHUB_OUTPUT
else # changes > 0 (or) MANUAL_REBUILD=true
echo "Pushing rebased commits"
git push origin $(git rev-parse --abbrev-ref HEAD) --no-verify
fi
build_mac:
name: 'macos ${{ github.event.inputs.message }}'
needs: check_updates
if: ${{ (needs.check_updates.outputs.should_run != 'false') && (github.event_name != 'workflow_dispatch' || (github.event_name == 'workflow_dispatch' && (contains(github.event.inputs.message, '[macOS]') || (!contains(github.event.inputs.message, '[macOS]') && !contains(github.event.inputs.message, '[Linux]') && !contains(github.event.inputs.message, '[Windows]'))))) }}
runs-on: macos-12
steps:
- name: Set env vars
run: |
echo "NPM_CACHE=$HOME/.npm" >> $GITHUB_ENV
echo "ELECTRON_CACHE=$HOME/.cache/electron" >> $GITHUB_ENV
echo "ELECTRON_BUILDER_CACHE=$HOME/.cache/electron-builder" >> $GITHUB_ENV
echo "MANUAL_REBUILD_ON_NIGHTLY=${{ github.event_name == 'workflow_dispatch' && contains(github.event.inputs.message, '[nightly branch]') }}" >> $GITHUB_ENV
- name: Checkout code along with submodules for the 'nightly' branch if the trigger event is 'scheduled' or this is a forced rebuild on the nightly branch
uses: actions/checkout@v4
if: ${{ github.event_name == 'schedule' || env.MANUAL_REBUILD_ON_NIGHTLY == 'true' }}
with:
submodules: recursive
fetch-depth: 0 # Note: Needed to be able to pull the 'develop' branch as well for merging
ref: nightly
- name: Checkout code along with submodules for any branch if the trigger event is NOT 'scheduled' and this is NOT a forced rebuild on the nightly branch
uses: actions/checkout@v4
if: ${{ github.event_name != 'schedule' && env.MANUAL_REBUILD_ON_NIGHTLY != 'true' }}
with:
submodules: recursive
fetch-depth: 0 # Note: Needed to be able to pull the 'develop' branch as well for merging
- name: Extract Git branch name from the currently checked out branch (not from the branch where this run was kicked off)
run: echo "GIT_BRANCH_NAME=$(git rev-parse --abbrev-ref HEAD)" >> $GITHUB_ENV
shell: bash
- name: Cache electron modules
uses: actions/cache@v4
env:
cache-name: cache-electron-modules
with:
key: ${{ runner.os }}-${{ env.cache-name }}-${{ secrets.CACHE_VERSION }}-${{ hashFiles('./pnpm-lock.yaml') }}
path: ${{ env.ELECTRON_CACHE }}
- name: Cache electron-builder modules
uses: actions/cache@v4
env:
cache-name: cache-electron-builder-modules
with:
key: ${{ runner.os }}-${{ env.cache-name }}-${{ secrets.CACHE_VERSION }}-${{ hashFiles('./pnpm-lock.yaml') }}
path: ${{ env.ELECTRON_BUILDER_CACHE }}
- name: Install pnpm
uses: pnpm/action-setup@v3
- name: Use Node.js specified in the '.nvmrc' file
uses: actions/setup-node@v4
with:
node-version-file: '.nvmrc'
cache: 'pnpm'
- name: Install node dependencies
uses: nick-fields/retry@v3
with:
command: pnpm i
timeout_minutes: 15
max_attempts: 3
retry_on: error
- name: Package recipes
run: pnpm i && pnpm lint && pnpm reformat-files && pnpm package
working-directory: ./recipes
- name: Run linter and tests
run: pnpm lint && pnpm test
- name: Build Ferdium without publish for any branch not 'nightly' and not 'release'
if: ${{ env.GIT_BRANCH_NAME != 'nightly' && env.GIT_BRANCH_NAME != 'release' }}
env:
CSC_IDENTITY_AUTO_DISCOVERY: false
run: pnpm build --publish never
shell: bash
- name: "Build Ferdium with publish for '${{ env.GIT_BRANCH_NAME }}' branch"
if: ${{ env.GIT_BRANCH_NAME == 'nightly' || env.GIT_BRANCH_NAME == 'release' }}
env:
GH_TOKEN: ${{ secrets.FERDIUM_PUBLISH_TOKEN }}
CSC_IDENTITY_AUTO_DISCOVERY: true
APPLEID: ${{ secrets.APPLEID }}
APPLEID_PASSWORD: ${{ secrets.APPLEID_PASSWORD }}
CSC_LINK: ${{ secrets.CSC_LINK }}
CSC_KEY_PASSWORD: ${{ secrets.CSC_KEY_PASSWORD }}
run: pnpm build --publish always
shell: bash
build_linux:
name: 'ubuntu ${{ github.event.inputs.message }}'
needs: check_updates
if: ${{ (needs.check_updates.outputs.should_run != 'false') && (github.event_name != 'workflow_dispatch' || (github.event_name == 'workflow_dispatch' && (contains(github.event.inputs.message, '[Linux]') || (!contains(github.event.inputs.message, '[macOS]') && !contains(github.event.inputs.message, '[Linux]') && !contains(github.event.inputs.message, '[Windows]'))))) }}
runs-on: ubuntu-22.04
steps:
- name: Set env vars
run: |
echo "NPM_CACHE=$HOME/.npm" >> $GITHUB_ENV
echo "ELECTRON_CACHE=$HOME/.cache/electron" >> $GITHUB_ENV
echo "ELECTRON_BUILDER_CACHE=$HOME/.cache/electron-builder" >> $GITHUB_ENV
echo "MANUAL_REBUILD_ON_NIGHTLY=${{ github.event_name == 'workflow_dispatch' && contains(github.event.inputs.message, '[nightly branch]') }}" >> $GITHUB_ENV
- name: Checkout code along with submodules for the 'nightly' branch if the trigger event is 'scheduled' or this is a forced rebuild on the nightly branch
uses: actions/checkout@v4
if: ${{ github.event_name == 'schedule' || env.MANUAL_REBUILD_ON_NIGHTLY == 'true' }}
with:
submodules: recursive
fetch-depth: 0 # Note: Needed to be able to pull the 'develop' branch as well for merging
ref: nightly
- name: Checkout code along with submodules for any branch if the trigger event is NOT 'scheduled' and this is NOT a forced rebuild on the nightly branch
uses: actions/checkout@v4
if: ${{ github.event_name != 'schedule' && env.MANUAL_REBUILD_ON_NIGHTLY != 'true' }}
with:
submodules: recursive
fetch-depth: 0 # Note: Needed to be able to pull the 'develop' branch as well for merging
- name: Extract Git branch name from the currently checked out branch (not from the branch where this run was kicked off)
run: echo "GIT_BRANCH_NAME=$(git rev-parse --abbrev-ref HEAD)" >> $GITHUB_ENV
shell: bash
- name: Cache electron modules
uses: actions/cache@v4
env:
cache-name: cache-electron-modules
with:
key: ${{ runner.os }}-${{ env.cache-name }}-${{ secrets.CACHE_VERSION }}-${{ hashFiles('./pnpm-lock.yaml') }}
path: ${{ env.ELECTRON_CACHE }}
- name: Cache electron-builder modules
uses: actions/cache@v4
env:
cache-name: cache-electron-builder-modules
with:
key: ${{ runner.os }}-${{ env.cache-name }}-${{ secrets.CACHE_VERSION }}-${{ hashFiles('./pnpm-lock.yaml') }}
path: ${{ env.ELECTRON_BUILDER_CACHE }}
- name: Install pnpm
uses: pnpm/action-setup@v3
- name: Use Node.js specified in the '.nvmrc' file
uses: actions/setup-node@v4
with:
node-version-file: '.nvmrc'
cache: 'pnpm'
- name: Install node dependencies
uses: nick-fields/retry@v3
with:
command: pnpm i
timeout_minutes: 15
max_attempts: 3
retry_on: error
- name: Figure out used package.json version
run: |
PACKAGE_VERSION="$(node -p 'require("./package.json").version')"
echo "PACKAGE_VERSION=$PACKAGE_VERSION" >> $GITHUB_ENV
if [[ "$GIT_BRANCH_NAME" == "nightly" ]]; then
echo "SNAP_PUBLISH_REPO=nightlies" >> $GITHUB_ENV
echo "SNAP_PUBLISH_CHANNEL=edge" >> $GITHUB_ENV
elif [[ "$GIT_BRANCH_NAME" == "release" ]]; then
echo "SNAP_PUBLISH_REPO=ferdium" >> $GITHUB_ENV
if [[ "$PACKAGE_VERSION" =~ "beta" ]]; then
echo "SNAP_PUBLISH_CHANNEL=beta" >> $GITHUB_ENV
else
echo "SNAP_PUBLISH_CHANNEL=stable" >> $GITHUB_ENV
fi
else
echo "SNAP_PUBLISH_REPO=none" >> $GITHUB_ENV
echo "SNAP_PUBLISH_CHANNEL=none" >> $GITHUB_ENV
fi
shell: bash
- name: Package recipes
run: pnpm i && pnpm lint && pnpm reformat-files && pnpm package
working-directory: ./recipes
- name: Run linter and tests
run: pnpm lint && pnpm test
- name: Build Ferdium without publish for any branch not 'nightly' and not 'release'
if: ${{ env.GIT_BRANCH_NAME != 'nightly' && env.GIT_BRANCH_NAME != 'release' }}
env:
CSC_IDENTITY_AUTO_DISCOVERY: false
run: pnpm build --publish never
shell: bash
- name: "Build Ferdium with publish for '${{ env.GIT_BRANCH_NAME }}' branch"
if: ${{ env.GIT_BRANCH_NAME == 'nightly' || env.GIT_BRANCH_NAME == 'release' }}
env:
GH_TOKEN: ${{ secrets.FERDIUM_PUBLISH_TOKEN }}
CSC_IDENTITY_AUTO_DISCOVERY: false
SNAPCRAFT_STORE_CREDENTIALS: ${{ secrets.SNAPCRAFT_LOGIN }} # Note: Login no longer required https://forum.snapcraft.io/t/snapcraft-authentication-options/30473/21
run: |
sudo snap install snapcraft --channel=7.x/stable --classic
pnpm build --publish always -c.snap.publish.repo=$SNAP_PUBLISH_REPO -c.snap.publish.channels=$SNAP_PUBLISH_CHANNEL
snapcraft logout
shell: bash
build_windows:
name: 'windows ${{ github.event.inputs.message }}'
needs: check_updates
if: ${{ (needs.check_updates.outputs.should_run != 'false') && (github.event_name != 'workflow_dispatch' || (github.event_name == 'workflow_dispatch' && (contains(github.event.inputs.message, '[Windows]') || (!contains(github.event.inputs.message, '[macOS]') && !contains(github.event.inputs.message, '[Linux]') && !contains(github.event.inputs.message, '[Windows]'))))) }}
runs-on: windows-2022
steps:
- name: Set env vars
run: |
echo "HOME=$USERPROFILE" >> $GITHUB_ENV
echo "NPM_CACHE=$USERPROFILE/.npm" >> $GITHUB_ENV
echo "ELECTRON_CACHE=$USERPROFILE/.cache/electron" >> $GITHUB_ENV
echo "ELECTRON_BUILDER_CACHE=$USERPROFILE/.cache/electron-builder" >> $GITHUB_ENV
echo "MANUAL_REBUILD_ON_NIGHTLY=${{ github.event_name == 'workflow_dispatch' && contains(github.event.inputs.message, '[nightly branch]') }}" >> $GITHUB_ENV
shell: bash
- name: Checkout code along with submodules for the 'nightly' branch if the trigger event is 'scheduled' or this is a forced rebuild on the nightly branch
uses: actions/checkout@v4
if: ${{ github.event_name == 'schedule' || env.MANUAL_REBUILD_ON_NIGHTLY == 'true' }}
with:
submodules: recursive
fetch-depth: 0 # Note: Needed to be able to pull the 'develop' branch as well for merging
ref: nightly
- name: Checkout code along with submodules for any branch if the trigger event is NOT 'scheduled' and this is NOT a forced rebuild on the nightly branch
uses: actions/checkout@v4
if: ${{ github.event_name != 'schedule' && env.MANUAL_REBUILD_ON_NIGHTLY != 'true' }}
with:
submodules: recursive
fetch-depth: 0 # Note: Needed to be able to pull the 'develop' branch as well for merging
- name: Extract Git branch name from the currently checked out branch (not from the branch where this run was kicked off)
run: echo "GIT_BRANCH_NAME=$(git rev-parse --abbrev-ref HEAD)" >> $GITHUB_ENV
shell: bash
- name: Cache electron modules
uses: actions/cache@v4
env:
cache-name: cache-electron-modules
with:
key: ${{ runner.os }}-${{ env.cache-name }}-${{ secrets.CACHE_VERSION }}-${{ hashFiles('./pnpm-lock.yaml') }}
path: ${{ env.ELECTRON_CACHE }}
- name: Cache electron-builder modules
uses: actions/cache@v4
env:
cache-name: cache-electron-builder-modules
with:
key: ${{ runner.os }}-${{ env.cache-name }}-${{ secrets.CACHE_VERSION }}-${{ hashFiles('./pnpm-lock.yaml') }}
path: ${{ env.ELECTRON_BUILDER_CACHE }}
- name: Install pnpm
uses: pnpm/action-setup@v3
- name: Use Node.js specified in the '.nvmrc' file
uses: actions/setup-node@v4
with:
node-version-file: '.nvmrc'
cache: 'pnpm'
#TODO - Remove this once https://github.com/electron-userland/electron-builder/issues/6933#issuecomment-1213438889 is resolved
- name: Tweak pnpm.cjs
run: |
# Run the command to get the pnpm store path and store it in a variable
PNPM_BASEDIR=$(dirname "$(echo "$PNPM_HOME" | sed -e 's/\\/\//g' -e 's/^\([A-Za-z]\):/\/\1/')")
sed -i 's/\/usr\/bin\/env node/node/g' "$PNPM_BASEDIR/pnpm/bin/pnpm.cjs"
shell: bash
- name: Install node dependencies
uses: nick-fields/retry@v3
with:
command: pnpm i
timeout_minutes: 15
max_attempts: 3
retry_on: error
- name: Package recipes
run: pnpm i && pnpm lint && pnpm reformat-files && pnpm package
working-directory: ./recipes
shell: bash
- name: Run linter and tests
run: pnpm lint && pnpm test
shell: bash
- name: Build Ferdium without publish for any branch not 'nightly' and not 'release'
if: ${{ env.GIT_BRANCH_NAME != 'nightly' && env.GIT_BRANCH_NAME != 'release' }}
env:
CSC_IDENTITY_AUTO_DISCOVERY: false
run: pnpm build --publish never
shell: bash
- name: "Build Ferdium with publish for '${{ env.GIT_BRANCH_NAME }}' branch"
if: ${{ env.GIT_BRANCH_NAME == 'nightly' || env.GIT_BRANCH_NAME == 'release' }}
env:
GH_TOKEN: ${{ secrets.FERDIUM_PUBLISH_TOKEN }}
CSC_IDENTITY_AUTO_DISCOVERY: false
run: pnpm build --publish always
shell: bash
|
