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/build-dev-browser.md
+43-30Lines changed: 43 additions & 30 deletions
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@
18
18
* You should be following along with zulipchat when using the `dev branch`
19
19
* Summary build updates can be found under the [One-Time Changes](#one-time-changes) section
20
20
21
-
You can build any desired branch (available at LoopKit/LoopWorkspace) using the *GitHub* Browser build method. This section is suitable if you have already built either `dev` or main branch using the [GitHub First-Time](gh-first-time.md) instructions.
21
+
You can build any desired branch (available at LoopKit/LoopWorkspace) using the *GitHub* Browser build method. This section is suitable if you have already built either `dev` or main branch using the [GitHub First-Time](gh-first-time.md){: target="_blank" } instructions.
22
22
23
23
The graphics on this page show the `dev` branch. If you want a different branch, just substitute that branch name for `dev`.
24
24
@@ -56,6 +56,8 @@ Each step in the list below matches with the number in the graphic. In the top h
56
56
57
57
### Update `Branch`
58
58
59
+
> **If you normally build released code, but decided to build the `dev branch` because you want the features and bug fixes found there, please do not update the fork for the `dev branch` without first finding out what has changed since your last build.**
60
+
59
61
Tap the `Code` button (upper left) and ensure this branch in your `fork` is up to date.
60
62
61
63
* Select the desired branch in the dropdown menu (this graphic shows `dev` branch)
@@ -72,41 +74,41 @@ If you have already completed the One-Time Changes, skip ahead to [Build `Branch
72
74
73
75
#### Transition to `dev`
74
76
75
-
When updating from _<spantranslate="no">Loop</span>_ 3.2.x to `dev`, you will need to take some extra steps.
77
+
When updating from _<spantranslate="no">Loop</span>_ 3.2.3 to `dev`, you will need to take some extra steps.
76
78
77
-
You have a choice:
79
+
**We recommend most users leave their default branch as `main`.**
78
80
79
-
*You can change your default branch to `dev`, see [Change Default `Branch`](#change-default-branch) and then your _<spantranslate="no">Loop</span>_ app will be automatically updated and automatically built at least once a month
80
-
* Be sure to review the [Modify Automatic Building](automatic.md#modify-automatic-building) section
81
-
* You can leave your default branch at main, but no automated updates will happen
82
-
* Running each action below requires you to select the `dev` branch in the drop-down menu
81
+
*This is the safest choice if you are choosing to build `dev branch` now because you want the bug fixes and features that are found in `dev`
82
+
* When version 3.4.0 is released, most users will return to the building the `main branch`
83
+
* At that time, simply update your `main` branch and return to using released code
84
+
* Each action below requires you to select the `dev` branch in the drop-down menu
83
85
84
-
Here is a summary of the extra steps; each step has an associated link. This assumes you have already updated your `fork` and are at the correct branch.
86
+
Here is a summary of the extra steps you will follow as you progress through this section.
85
87
86
-
1. Confirm the status of your <spantranslate="no">*GitHub* Personal Access Token</span>
88
+
1. Confirm the status of your <spantranslate="no">*GitHub* Personal Access Token</span>
87
89
* It should be configured with permission scope of `repo, workflow` and to never expire
88
-
* You can check this using directions at [*GitHub* Token](gh-update.md#github-token)
89
-
1.Next, follow along in this section to perform these steps before you build
90
-
* Add and Update `New Indentifier`
91
-
*`Create Certificates`
90
+
* You can check this using directions at [*GitHub* Token](gh-update.md#github-token){: target="_blank" }
91
+
1.[Add and Update `New Identifier`](#add-and-update-new-identifier)
92
+
1.[`Create Certificates`](#create-certificates)
93
+
1.[`Build Loop`](#build-branch)
92
94
93
95
#### Automatic Creation of `alive branch`
94
96
95
-
!!! warning "What about the `alive branch`"
97
+
The `alive branch` is created automatically when you run the `Build Loop` action using the `dev branch` (version 3.3 or later). It is used as part of the automatic build process that will be released with the next version.
98
+
99
+
??? warning "I got an error regarding the `alive branch` (click to open/close)"
96
100
* Sometimes you get an error about the `alive branch`
97
-
* It should be created for you automatically if you are building with the `dev branch`**and** you have `workflow` permission added to the `scope` for your *GitHub*`Personal Access Token`
98
-
* If necessary, delete the `alive branch`and run the `Build Loop` action again
101
+
* If you do get an error, delete the `alive branch` and run the `Build Loop` action again
102
+
* 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
99
103
100
104
#### Add and Update New `Identifier`
101
105
102
106
The `bundle ID` for the "`widget`" changed from "`SmallStatusWidget`" to the more descriptive "`LoopWidgetExtension`".
103
107
104
-
* You need to run Add Identifier - be sure that you run this for the `dev branch`
108
+
* You need to run `Add Identifier` - be sure to select the `dev branch` when you run this action
105
109
* Wait for it to succeed
106
110
* Add the `App Group` to this one new Identifier
107
111
108
-
All other identifiers should be already set up. If they are not, please go through the steps on the [Configure to Use Browser](gh-first-time.md) page to figure out what you are missing.
@@ -115,26 +117,41 @@ All other identifiers should be already set up. If they are not, please go throu
115
117
* Click on the "`LoopWidgetExtension`" identifier
116
118
* Edit the App Group to include `group.com.TEAMID.loopkit.LoopGroup` where you use your `TEAMID`
117
119
118
-
#### Create Certificates and Build
120
+
??? tip "Other Identifiers (Click to Open/Close)"
121
+
All other identifiers should be already set up.
122
+
123
+
* If they are not, refer to [Configure to Use Browser: Add App Group to Identifiers](gh-first-time.md#add-app-group-to-identifiers){: target="_blank" }
124
+
* With the `dev branch`, only the App Group needs to be added; all other `Identifier` settings are automatically included.
119
125
120
-
You must create certificates again to cover the new Identifier name and to provide support for the addition of the Libre sensors. (This step is required whether you use Libre or not - Loop needs permission to have that capability). Once the certificate action succeeds, then run the action to build Loop.
126
+
#### Create Certificates
121
127
122
-
1. Run the Action for Create Certificates - be sure that you run this for the `dev branch`
123
-
1. Run the Action for `Build Loop` (see [Build `Branch`](#build-branch))
128
+
You must run the action `Create Certificates` again because the `Identifiers` were updated. Be sure that you run this for the `dev branch`
124
129
125
130
### Build `Branch`
126
131
127
-
If you want a branch to be the one you build all the time, you may choose to [Change Default `Branch`](#change-default-branch). This is not necessary except for special cases.
132
+
> **We recommend most users leave their default branch as `main`.**
128
133
129
-
If you have one branch as default, for example main, and choose to build a different branch, there is an extra step when you `Build Loop`. Refer to step 4 in the graphic below. Use the branchdropdown menu to select the branch you want before hitting the green Run workflow button.
134
+
If you have one branch as default, for example `main`, and choose to build a different branch, there is an extra step when you `Build Loop`. In addition to the normal steps 1, 2 and 3 in the graphic below, you must also do the (optional) step. Select the `dev branch` in the `branch dropdown` menu before continuing to step 4 and tapping on the green Run workflow button.
130
135
131
136
{width="700"}
132
137
{align="center"}
133
138
134
-
!!!
139
+
#### Refresh, Do Not Repeat
140
+
141
+
!!! tip "Hit Refresh"
142
+
After you tap the green Run workflow button, *GitHub* can be slow to update.
143
+
144
+
* Refresh the browser if you are unsure if the action started
145
+
* Do not start a new action until the first one completes
146
+
147
+
## Automatic Update & Build
148
+
149
+
The automatic update and build features of the development branch are only available if you set the `dev` branch as your default branch. Be sure to read the [Automatic Update & Build](automatic.md) if you did this.
135
150
136
151
## Change Default `Branch`
137
152
153
+
> **We recommend most users leave their default branch as `main`.**
154
+
138
155
There can be several reasons why you would change your default branch.
139
156
140
157
* It can be convenient to have the branch you build most be configured as the default branch
@@ -171,7 +188,3 @@ For the numbered steps below, refer to the graphic found under each group of ste
171
188
{align="center"}
172
189
173
190
Your default branch has been changed.
174
-
175
-
## Automatic Update & Build
176
-
177
-
The automatic update and build features of the development branch are only available if you set the `dev` branch as your default branch. Be sure to read the [Automatic Update & Build](automatic.md) if you did this.
0 commit comments