Skip to content

Commit f0fc918

Browse files
bjornolehbjornoleh
authored
Add scheduled sync and build, and allow for customization of Loop with GitHub Actions / Fastlane builds (LoopKit#43)
* Scheduled sync and build, with option to customize Loop Changed template for scheduled runs to every month Added env variables for - upstream and target repo/branches - sync upstream 'true'/'false' - customize app 'true'/'false' Added sync action (aormsby/Fork-Sync-With-Upstream-action) to the (sync and) build job Added gautamkrishnar/keepalive-workflow to avoid expiration of scheduled workflows due to repository inactivity (60 days max). Adds an empty commit to fork if no activity during the last 27 days. Added Customize Loop action, which - applies any patches located in the LoopWorkspace/patches/ directory (@billybooth) - downloads (wget) and applies submodule patches specified in build_loop.yml Added (commented-out) CustomTypeOne/LoopPatches as templates for Loop and LoopKit submodule patches. * Add ./patches/save_patches_here.md * build_loop.yml: update patch templates for submodules * build_loop.yml: comment out patch template for submodule Loop * build_loop.yml: patch template app name = CustomLoop * Update build_loop.yml: fix typo * Update save_patches_here.md: fix typo * build_loop.yml: delete test_mode * build_loop.yml: remove env CUSTOMIZE_APP * Update build_loop.yml: remove remaining env CUSTOMIZE_APP refs * build_loop.yml: remove '--exclude=' from 'git apply' * Create update.yml - runs on a frequent schedule - checks out LoopWorkspace `main` - compares and syncs with LoopKit/LoopWorkspace (unless owner = LoopKit) - keepalive action adds empty commits to LoopKit/LoopWorkspace `main` after `time_elapsed` days to to avoid inactivation of scheduled workflows, when these updates are passed on to forks (only if owner = LoopKit) - launches build_loop.yml workflow on forks to sync and build if new commits are found (unless owner = LoopKit) * Remove keepalive action from build_loop.yml - keepalive action moved to update.yml * Adapt build_loop.yml and update.yml to be run in an "actions" branch to be set as default, and used to trigger scheduled builds of the main branch. Empty commits are added to an "actions" branch only (must be created by the user and set as default) to keep this branch "alive" and allow scheduled workflows to run uninterrupted (max 60 days of inactivity). The empty commits will not be included in the resulting TestFlight builds of main. Removed conditionals regarding LoopKit repository. * build_loop.yml: Add job names for `secrets` and `upstream_sync_and_build` * update.yml: shorter job name for `check_latest_from_upstream`: Check upstream * build_loop.yml: use curl instead of wget for downloading patches * Changes to build_loop.yml and update.yml: build_loop.yml: -Remove sync action from build_loop.yml -build on schedule on the 1th every month for a predictable build schedule well within the 90 day TestFlight limit. The time of day should be chosen as a time where ongoing changes are unlikely during releases (nighttime). -rename env TARGET_BRANCH to BUILD_BRANCH - use current branch as BUILD_BRANCH for easy switching to building main or dev (manually insert alternative branch names as needed) update.yml: - check for updates every day - use current branch name for UPSTREAM_BRANCH and TARGET_BRANCH, to easily switch between dev and main by changing default branch, without any code changes. - do not run the upstream sync action on the upstream LoopKit repository - time_elapsed: 50 days for keepalive action * Add branch name to run-names - with round brackets around branch name for readability: (${{ github.ref_name }}) * Remove mention of setting TARGET_BRANCH as default, since its not fixed * Move update and keep alive features to build_loop.yml - Checks for updates nightly - Ensures repository activity - Launches Build job if new commits are found, or if run manually - Workflow file cleanup * Delete update.yml * testflight.md: update GH_PAT instructions * Change the Expiration selection to `No expiration`. * Select the `repo` and `workflow` permission scopes. * testflight.md instructions: Create a branch named "alive" * testflight.md: rephrase section on ‘Create a branch named "alive"’
1 parent 614c9e9 commit f0fc918

File tree

3 files changed

+130
-13
lines changed

3 files changed

+130
-13
lines changed

‎.github/workflows/build_loop.yml

+113-11
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,136 @@
11
name: 4. Build Loop
2-
run-name: Build Loop ${{ github.ref_name }}
2+
run-name: Build Loop (${{ github.ref_name }})
33
on:
44
workflow_dispatch:
55

66
## Remove the "#" sign from the beginning of the line below to get automated builds on push (code changes in your repository)
77
#push:
88

9-
## Remove the "#" sign from the beginning of the two lines below to get automated builds every two months
10-
#schedule:
11-
#- cron: '0 17 1 */2 *' # Runs at 17:00 UTC on the 1st in Jan, Mar, May, Jul, Sep and Nov.
9+
schedule:
10+
- cron: '0 04 * * *' # Checks for updates at 04:00 UTC every day
11+
- cron: '0 04 1 * *' # Builds the app on the 1th every month
12+
13+
env:
14+
UPSTREAM_REPO: LoopKit/LoopWorkspace
15+
UPSTREAM_BRANCH: ${{ github.ref_name }} # branch on upstream repository to sync from (relpace with specific branch name if needed)
16+
TARGET_BRANCH: ${{ github.ref_name }} # target branch on fork to be kept in sync, and target branch on upstream to be kept alive (relpace with specific branch name if needed)
17+
ALIVE_BRANCH: alive
18+
SYNC_UPSTREAM: 'true' # set to 'false' or 'true' to disable / enable syncing of fork with upstream repository
1219

1320
jobs:
14-
secrets:
15-
uses: ./.github/workflows/validate_secrets.yml
16-
secrets: inherit
21+
check_latest_from_upstream:
22+
runs-on: ubuntu-latest
23+
name: Check upstream and keep alive
24+
outputs:
25+
NEW_COMMITS: ${{ steps.sync.outputs.has_new_commits }}
26+
27+
steps:
28+
- name: Checkout target repo
29+
uses: actions/checkout@v3
30+
with:
31+
token: ${{ secrets.GH_PAT }}
32+
ref: alive
33+
34+
- name: Sync upstream changes
35+
if: ${{ env.SYNC_UPSTREAM == 'true' }} && github.repository_owner != 'LoopKit' # do not run the upstream sync action on the upstream repository
36+
id: sync
37+
uses: aormsby/Fork-Sync-With-Upstream-action@v3.4
38+
with:
39+
target_sync_branch: ${{ env.ALIVE_BRANCH }}
40+
shallow_since: 6 months ago
41+
target_repo_token: ${{ secrets.GH_PAT }}
42+
upstream_sync_branch: ${{ env.UPSTREAM_BRANCH }}
43+
upstream_sync_repo: ${{ env.UPSTREAM_REPO }}
44+
45+
# Display a sample message based on the sync output var 'has_new_commits'
46+
- name: New commits found
47+
if: steps.sync.outputs.has_new_commits == 'true'
48+
run: echo "New commits were found to sync."
1749

50+
- name: No new commits
51+
if: steps.sync.outputs.has_new_commits == 'false'
52+
run: echo "There were no new commits."
53+
54+
- name: Show value of 'has_new_commits'
55+
run: |
56+
echo ${{ steps.sync.outputs.has_new_commits }}
57+
echo "NEW_COMMITS=${{ steps.sync.outputs.has_new_commits }}" >> $GITHUB_OUTPUT
58+
59+
# Keep repository "alive": add empty commits to ALIVE_BRANCH after "time_elapsed" days of inactivity to avoid inactivation of scheduled workflows
60+
- name: Keep alive
61+
uses: gautamkrishnar/keepalive-workflow@v1 # using the workflow with default settings
62+
with:
63+
time_elapsed: 20 # Time elapsed from the previous commit to trigger a new automated commit (in days)
64+
1865
build:
19-
needs: secrets
66+
name: Build
67+
needs: check_latest_from_upstream
2068
runs-on: macos-13
69+
if: ${{ github.event_name == 'workflow_dispatch' || github.event.schedule == '0 04 1 * *' || needs.check_latest_from_upstream.outputs.NEW_COMMITS == 'true' }} # runs if started manually, or if scheduled on the first each month, or if new commits were found
2170
steps:
22-
# Uncomment to manually select latest Xcode if needed
23-
- name: Select Latest Xcode
71+
- name: Select Xcode version
2472
run: "sudo xcode-select --switch /Applications/Xcode_14.3.1.app/Contents/Developer"
2573

26-
# Checks-out the repo
2774
- name: Checkout Repo
2875
uses: actions/checkout@v3
2976
with:
77+
token: ${{ secrets.GH_PAT }}
3078
submodules: recursive
79+
ref: ${{ env.TARGET_BRANCH }}
80+
81+
- name: Sync upstream changes
82+
if: ${{ env.SYNC_UPSTREAM == 'true' }} && github.repository_owner != 'LoopKit' # do not run the upstream sync action on the upstream repository
83+
id: sync
84+
uses: aormsby/Fork-Sync-With-Upstream-action@v3.4
85+
with:
86+
target_sync_branch: ${{ env.TARGET_BRANCH }}
87+
shallow_since: 6 months ago
88+
target_repo_token: ${{ secrets.GH_PAT }}
89+
upstream_sync_branch: ${{ env.UPSTREAM_BRANCH }}
90+
upstream_sync_repo: ${{ env.UPSTREAM_REPO }}
91+
92+
# Display a sample message based on the sync output var 'has_new_commits'
93+
- name: New commits found
94+
if: steps.sync.outputs.has_new_commits == 'true'
95+
run: echo "New commits were found to sync."
96+
97+
- name: No new commits
98+
if: steps.sync.outputs.has_new_commits == 'false'
99+
run: echo "There were no new commits."
31100

101+
- name: Show value of 'has_new_commits'
102+
run: |
103+
echo ${{ steps.sync.outputs.has_new_commits }}
104+
echo "NEW_COMMITS=${{ steps.sync.outputs.has_new_commits }}" >> $GITHUB_OUTPUT
105+
106+
# Customize Loop: Download and apply patches
107+
- name: Customize Loop
108+
run: |
109+
110+
# LoopWorkspace patches
111+
# -applies any patches located in the LoopWorkspace/patches/ directory
112+
if $(ls ./patches/* &> /dev/null); then
113+
git apply ./patches/* --allow-empty -v --whitespace=fix
114+
fi
115+
116+
# Submodule Loop patches:
117+
# Template for customizing submodule Loop (changes Loop app name to "CustomLoop")
118+
# Remove the "#" sign from the beginning of the line below to activate:
119+
#curl https://github.com/loopnlearn/Loop/commit/d206432b024279ef710df462b20bd464cd9682d4.patch | git apply --directory=Loop -v --whitespace=fix
120+
121+
# Submodule LoopKit patches:
122+
# General template for customizing submodule LoopKit
123+
# Copy url from a GitHub commit or pull request and insert below, and remove the "#" sign from the beginning of the line to activate:
124+
#curl url_to_github_commit.patch | git apply --directory=LoopKit -v --whitespace=fix
125+
126+
# Submodule xxxxx patches:
127+
128+
# Add patches for customization of additional submodules by following the templates above,
129+
# and make sure to specify the submodule by setting "--directory=(submodule_name)".
130+
# Several patches may be added per submodule.
131+
# Adding comments (#) may be useful to easily tell the individual patches apart.
132+
133+
32134
# Patch Fastlane Match to not print tables
33135
- name: Patch Match Tables
34136
run: find /usr/local/lib/ruby/gems -name table_printer.rb | xargs sed -i "" "/puts(Terminal::Table.new(params))/d"

‎fastlane/testflight.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ Log into your GitHub account to create a personal access token; this is one of t
4848

4949
1. Create a [new personal access token](https://github.com/settings/tokens/new):
5050
* Enter a name for your token, use "FastLane Access Token".
51-
* Change the selection to 90 days.
52-
* Select the `repo` permission scope.
51+
* Change the Expiration selection to `No expiration`.
52+
* Select the `repo` and `workflow` permission scopes.
5353
* Click "Generate token".
5454
* Copy the token and record it. It will be used below as `GH_PAT`.
5555

@@ -159,6 +159,20 @@ You do not need to fill out the next form. That is for submitting to the app sto
159159
1. On the right side, click "Run Workflow", and tap the green `Run workflow` button.
160160
1. Wait, and within a minute or two you should see a green checkmark indicating the workflow succeeded.
161161

162+
## Create a branch named "alive"
163+
164+
TestFlight builds expire after 90 days. This process you are implementing here will update and rebuild Loop periodically, and requires that you create a branch named "alive" so that GitHub will not inactivate the scheduled rebuild if no code updates are made.
165+
166+
The "alive" branch will only receive some additional commits to its history, and is not used for building the app.
167+
168+
1. Go to the "Code" tab of your LoopWorkspace repository.
169+
1. Click the branch selection dropdown button, and then `View all branches`.
170+
1. Click the green "New branch" button (upper right).
171+
1. Type `alive` in the "New branch name" field.
172+
1. Select `LoopKit/LoopWorkspace` as "Source".
173+
1. Select `dev` in the branch dropdown.
174+
1. Click the green "Create new branch" button.
175+
162176
## Build Loop
163177

164178
1. Click on the "Actions" tab of your LoopWorkspace repository.

‎patches/save_patches_here.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
LoopWorkspace-level patches can be saved in this directory (LoopWorkspace/patches/)

0 commit comments

Comments
 (0)