You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/gh-actions/automatic.md
+35-31Lines changed: 35 additions & 31 deletions
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,16 @@
1
1
## Overview
2
2
3
-
The instructions on the [Configure to Use Browser](gh-first-time.md) page will, unless you make a change, automatically take the following actions for released versions 3.4.1 and newer:
3
+
The instructions on the [Configure to Use Browser](gh-first-time.md) page will, unless you make a change, automatically update and build for you.
4
4
5
-
* Update the version of your <spantranslate="no">fork</span> within a week of the change
6
-
* When an update to the default `branch`, typically `main`, is detected, a new build is created automatically and uploaded to *TestFlight*
7
-
* Build the app at least once a month and upload the fresh build to *TestFlight*
5
+
This keeps the most recent version of the *Loop* app available in *TestFlight* for you to install when you are ready.
8
6
9
-
If you do not want this automatic schedule, you can modify it.
7
+
These events are automatically scheduled:
10
8
11
-
This only works because of special branches that are automatically created in your repository.
9
+
* Once a week: Check for a new release of the *Loop* app:
10
+
* If found, your fork is automatically updated and a new build created and uploaded to *TestFlight*
11
+
* Once a month: Build the app and upload the fresh build to *TestFlight*
12
12
13
-
*[What are the `alive branches` and why do I need them?](#what-are-the-alive-branches-and-why-do-i-need-them)
13
+
If you do not want this automatic schedule, you can modify it.
14
14
15
15
Regardless of your choice, please [Disable Automatic Installation from *TestFlight*](gh-deploy.md#disable-automatic-install-from-testflight){: target="_blank" }. You should be alert any time your *Loop* app is updated. Check that all settings are maintained and pay attention to make sure the app behavior is nominal.
16
16
@@ -37,6 +37,34 @@ On the first day of every month at 06:00 UTC, you will see a successful `build a
37
37
38
38
You start getting [Notifications](../operation/features/notifications.md#loop-app-expiration-notification){: target="_blank" } when there are fewer than 20 days until expiration. When you see the warning, install the newest build from your *TestFlight* app. You do not want to get the dreaded "Loop Beta is not available" message on your phone. (The warnings get very agressive when close to expiration.)
39
39
40
+
### What are the `alive branches`?
41
+
42
+
The automatic update and build feature is embedded in the build_loop.yml code and uses the GitHub scheduling feature to trigger actions to run automatically.
43
+
44
+
Some may have noticed one or more branches added to your repository that start with the name `alive`. Don't worry about these. They are automatically created to ensure GitHub will keep building your app automatically.
45
+
46
+
* GitHub keeps track of repositories
47
+
* If there is no activity in a given repository in 60 days, GitHub disables Actions
48
+
* If your Actions are disabled, you don't get automatic builds
49
+
* Clever people developed a work around for this
50
+
51
+
You may see branches called `alive`, `alive-dev` or `alive-main` in your repository.
52
+
53
+
The `alive` branches are created and used to make sure at least one commit per month is added to an `alive` branch in your repository. That keeps your repository active to allow the automatic update and build process to work.
54
+
55
+
The `alive` branches are only used for the keep-alive functions. Do not build using an `alive` branch. Most people will build using the default branch of `main`.
56
+
57
+
#### Automatic Creation of `alive branch`
58
+
59
+
The `alive` branch you need is created automatically when you run the `Build Loop` action.
60
+
61
+
!!! warning "I got an error regarding a branch with `alive` in the name"
62
+
* Sometimes you get an error about an `alive` branch
63
+
* If you do get an error, simply delete the branch and run the `Build Loop` action again
64
+
* Use this [GitHub link](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository#deleting-a-branch){: target="_blank" } or ask for help when deleting a branch
65
+
* You can delete every branch that starts with the name `alive`
66
+
* Leave the other branches alone unless a mentor directs you to take action
67
+
40
68
## Modify Automatic Building
41
69
42
70
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.
@@ -128,27 +156,3 @@ What if I decide I don't want the automatic building feature?
128
156
* It is the Build action that kicks off the update and build steps, so simply disabling the one action is sufficient
129
157
130
158
* If you are done with Loop, you can delete the whole repository; but you should be sure about this because you'll need to start over with [Configure to Use Browser](gh-first-time.md) to restore ability to build Loop with GitHub.
131
-
132
-
## What are the `alive branches` and why do I need them?
133
-
134
-
The automatic update and build features of version 3.4.1 and later use branches that start with the name `alive`. You may see branches called `alive`, `alive-dev` and `alive-main` in your repository. These are automatically created. They are used to keep GitHub actions working in your repository.
135
-
136
-
* GitHub keeps track of repositories
137
-
* If there is no activity in a given repository in 60 days, GitHub disables Actions
138
-
139
-
In other words, during a time when the *Loop* app is fairly stable, your automatic update and build features would just stop working.
140
-
141
-
No one wants that. The `alive` branches are created and used to make sure at least one commit per month is added to an `alive` branch in your repository. That keeps your repository active to allow the automatic update and build process to work.
142
-
143
-
The `alive` branches are only used for the keep-alive functions. Do not build using an `alive` branch. Most people will build using the default branch of `main`.
144
-
145
-
#### Automatic Creation of `alive branch`
146
-
147
-
The `alive` branch you need is created automatically when you run the `Build Loop` action.
148
-
149
-
!!! warning "I got an error regarding a branch with `alive` in the name"
150
-
* Sometimes you get an error about an `alive` branch
151
-
* If you do get an error, simply delete the branch and run the `Build Loop` action again
152
-
* Use this [GitHub link](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository#deleting-a-branch){: target="_blank" } or ask for help when deleting a branch
153
-
* You can delete every branch that starts with the name `alive`
154
-
* Leave the other branches alone unless a mentor directs you to take action
Copy file name to clipboardExpand all lines: docs/gh-actions/gh-deploy.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -74,7 +74,7 @@ Recommended settings:
74
74
* Allow automatic build and upload to *TestFlight*
75
75
*[Disable automatic installation](#disable-automatic-install-from-testflight) on phone from *TestFlight*
76
76
77
-
If you are running the development code, you may prefer to turn off the automatic update, but keep the automatic build. To read more about modifying automatic update and build options, please read [Modify Automatic Building](automatic.md#modify-automatic-building){: target="_blank" }.
77
+
If you are running the development code, you may prefer to turn off the automatic update, but keep the automatic build. To read more about modifying automatic update and build options, please read [Automatic Update & Build](automatic.md){: target="_blank" }.
Copy file name to clipboardExpand all lines: docs/gh-actions/gh-errors.md
+6-3Lines changed: 6 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -2,16 +2,19 @@
2
2
3
3
If you get an error when building with a browser, use this page to figure out what to do.
4
4
5
-
If you are still unsuccessful, then post your request for help along with your *GitHub***username**. Mentors can go to your public _<spantranslate="no">GitHub repository</span>_, check the status and then view your log files directly.
5
+
If you are still unsuccessful, then post your request for help along with the link to your repository. For example - this link is used to test the build instructions and generate figures for LoopDocs. You replace your GitHub username where you see `loopdocs-tester`:
Mentors can go to your public _<spantranslate="no">GitHub repository</span>_, make sure your code is up to date, examine your customizations (if any), then click on the Action tab and view your log files directly.
6
10
7
11
* Do not copy from the log file and post the words
8
12
* Do not take a screenshot of what you think is an error
9
-
* Just post your username and the name of the app you are trying to build
10
13
11
14
!!! tip "Username, Not Pictures"
12
15
If you've been around the DIY community for a while, you know the mantra about screenshots. Well, when using a browser to build, **screenshots are close to useless**.
13
16
14
-
All that is needed to assist is your *GitHub* **username**.
17
+
All that is needed to assist is your link or as a bare minimum your *GitHub* **username**.
15
18
16
19
But first - try to diagnose it yourself using this page.
0 commit comments