Skip to content

Commit a059eee

Browse files
authored
Merge pull request #845 from marionbarker/working-docs
fix typo in table, clarify automatic build information
2 parents be92d21 + b92b2d6 commit a059eee

File tree

1 file changed

+22
-13
lines changed

1 file changed

+22
-13
lines changed

docs/gh-actions/automatic.md

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## Modify Automatic Building
88

9-
For someone using [development code](build-dev-browser.md) for their own use, they probably want to decide when to update their `fork` to the most recent commit. They can still have the advantage of automatic building without automatic updates. There may be other configurations someone would choose. These options are added to Loop 3.3.0 (`dev` branch) and later.
9+
For someone using [development code](build-dev-browser.md) for their own use, they could decide to choose when to update their `fork` to the most recent commit. They can still have the advantage of automatic building without automatic updates; in other words, they want a new build added to TestFlight every month. There may be other configurations someone would choose. These options are available starting with Loop 3.3.0 (`dev` branch) and later.
1010

1111
You can affect the default behavior:
1212

@@ -15,22 +15,31 @@ You can affect the default behavior:
1515

1616
### Modify Automatic Schedule
1717

18-
You can modify the automation by creating and using some variables.
18+
This is an optional step. If you are happy with the automatic sync and update, you are done with this page.
1919

20-
To configure the automated build more granularly involves creating up to two environment variables: `SCHEDULED_BUILD` and/or `SCHEDULED_SYNC`. See [How to configure a variable](#how-to-configure-a-variable).
20+
??? tip "Instructions to Modify the Automatic Actions (Click to Open/Close)"
21+
You can modify the automation by creating and using some variables.
2122

22-
Note that the weekly and monthly `Build Loop` actions will continue, but the actions are modified if one or more of these variables is set to false. **A successful Action Log will still appear, even if no automatic activity happens**.
23+
To configure the automated build more granularly involves creating up to two environment variables: `SCHEDULED_BUILD` and/or `SCHEDULED_SYNC`. See [How to configure a variable](#how-to-configure-a-variable).
2324

24-
* If you want to manually decide when to update your repository to the latest commit, but you want the monthly builds and keep-alive to continue: set `SCHEDULED_SYNC` to false and either do not create `SCHEDULED_BUILD` or set it to true
25-
* If you want to only build when an update has been found: set `SCHEDULED_BUILD` to false and either do not create `SCHEDULED_SYNC` or set it to true
26-
* **Warning**: if no updates to your default branch are detected within 90 days, your previous TestFlight build may expire requiring a manual build
25+
Note that the weekly and monthly `Build Loop` actions will continue, but the actions are modified if one or more of these variables is set to false. **A successful Action Log will still appear, even if no automatic activity happens**.
2726

28-
| <div style="width:120px">`SCHEDULED_SYNC`</div> | <div style="width:120px">`SCHEDULED_BUILD`</div> | Automatic Actions |
29-
|---|---|---|
30-
| `true` (or NA) | `true` (or NA) | keep-alive, weekly update check (auto update/build), monthly build with auto update|
31-
| `true` (or NA) | `false` | keep-alive, weekly update check with auto update, only builds if update detected|
32-
| `false` | `true` (or NA) | keep-alive, monthly build, no auto update |
33-
| `false` | `false` | no automatic activity, no keep-alive|
27+
* If you want to manually decide when to update your repository to the latest commit, but you want the monthly builds and keep-alive to continue:
28+
* create the variable `SCHEDULED_SYNC` and set it to false
29+
* either do not create the variable `SCHEDULED_BUILD` or set it to true
30+
* If you are building the `dev branch` at a time when there is a lot of activity in that branch, you may want this configuration
31+
* If you want to only build when an update has been found:
32+
* either do not create the variable `SCHEDULED_SYNC` or set it to true
33+
* create the variable `SCHEDULED_BUILD` and set it to false
34+
* **Warning**: if no updates to your default branch are detected within 90 days, your previous TestFlight build may expire requiring a manual build
35+
* During a time when updates are not happening frequently, this is not a good choice
36+
37+
| <div style="width:120px">`SCHEDULED_SYNC`</div> | <div style="width:120px">`SCHEDULED_BUILD`</div> | Automatic Actions |
38+
|---|---|---|
39+
| `true` (or N/A) | `true` (or N/A) | This is the default:<br>keep-alive, weekly update check (auto update/build), monthly build with auto update|
40+
| `false` | `true` (or N/A) | keep-alive, monthly build, no auto update |
41+
| `true` (or N/A) | `false` | keep-alive, weekly update check with auto update, only builds if update detected |
42+
| `false` | `false` | no automatic activity, no keep-alive|
3443

3544
### How to configure a variable
3645

0 commit comments

Comments
 (0)