Skip to content

Commit 29c6310

Browse files
authored
Merge pull request #611 from marionbarker/working-docs
Update instructions for GitHub customization
2 parents 733004b + f2a2da1 commit 29c6310

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

docs/gh-actions/gh-customize.md

+16-7
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@
2424
* LoopDocs: Decide on Modules to modify [Code Customization](../build/code_customization.md)
2525
* GitHub (each Module):
2626
1. Fork Module (GitHub)
27-
1. Modify Module (GitHub->Codespaces)
28-
1. Save your new branch (Codespaces->GitHub)
27+
1. Modify Module (GitHub to Codespaces)
28+
1. Save your new branch (Codespaces to GitHub)
2929
1. Prepare command line and save
3030
* All Module command lines prepared
3131
* GitHub (build Loop)
32-
1. Modify LoopWorkspace (GitHub->Codespaces)
33-
1. Save your new branch (Codespaces->GitHub)
32+
1. Modify LoopWorkspace (GitHub to Codespaces)
33+
1. Save your new branch (Codespaces to GitHub)
3434
1. Action: Build Loop
3535
* Phone: Install Loop with TestFlight
3636

@@ -170,11 +170,11 @@ If you have already made a customization in this module and you are returning fo
170170
* the branch is the default branch for this Module (dev or main)
171171
* this is where you will paste the command you're about to copy
172172

173-
The commands you paste depend on whether this is the first time you've worked with the Module or if you have already started customizing it and thus already have a main_3.2.1_custom branch created.
173+
The commands you paste depend on whether this is the first time you've worked with the Module for release 3.2.1 or if you have already started customizing it and thus already have a main_3.2.1_custom branch created.
174174

175175
### First Time for this Module
176176

177-
These commands are used ONLY for released version of Loop and only the first time you work with a given Module. This page is configured for released version 3.2.1.
177+
These commands are used ONLY for released version of Loop and only the first time you work with a given Module for release 3.2.1. This page is configured for released version 3.2.1.
178178

179179
This process has two steps:
180180

@@ -374,6 +374,9 @@ Prepare the commands for each Module customization you want for this build in yo
374374

375375
Only use this section if you have not previously created the main_3.2.1_custom branch for LoopWorkspace.
376376

377+
* Be sure to sync the main branch of your fork to LoopKit/LoopWorkspace main branch BEFORE opening the Codespace
378+
* If you followed the original directions to build without customization first, you will have already synced - but just in case you skipped that step, sync it now
379+
377380
Open the Codespace and select your fork of LoopWorkspace **main** branch.
378381

379382
Copy and paste the following lines into your terminal:
@@ -401,10 +404,14 @@ Type a message in the comment and click Commit.
401404

402405
Click on sync changes.
403406

407+
### Build Loop with Your Customizations
408+
404409
Return to your GitHub window for LoopWorkspaces.
405410

406-
* Modify the default branch to be main_3.2.1_custom
407411
* Click on Action: Build Loop
412+
* When you Click on Run workflow to see the dropdown
413+
* You must select your main_3.2.1_custom branch
414+
* Then click on the green Run Workflow button
408415

409416
In about 1 hour, your customized Loop will be available for installation on your phone via TestFlight.
410417

@@ -470,6 +477,8 @@ https://github.com/loopdocs-tester/Loop/compare/main...main_3.2.1_custom
470477

471478
You now have a "patch" text file. Download and save this file on your computer.
472479

480+
No instructions are available yet, but you might be able to reuse that patch for subsequent releases. We are still working on steps and methods to simplify the process.
481+
473482
The default name when you select File->Save Page As, is 1.patch.txt. It's a good idea to revise this. For the graphic below, the filename was modified to `Loop_main_3.2.1_custom_1.patch.txt` and a folder called `patches` in Downloads was used for storage.
474483

475484
![browser screen for saving the patch](img/patch-saved-for-loop.png){width="750"}

0 commit comments

Comments
 (0)