Skip to content

Clarify branch building and checking instructions #985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
carolvchn wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clarify branch building and checking instructions #985

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions docs/browser/build-dev-browser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,19 @@ The graphics on this page show the `dev` branch. If you want a different branch,
* You cannot just rename your existing branch to `dev` - you must get the `dev` branch from LoopKit
1. When you select the action `4. Build Loop` and then click on the `Run Workflow` dropdown, you must select `dev` there before clicking the green `Run workflow` button - see [Build `Branch`](#build-branch)

### Find Your Branch

If you're building 'dev', you can skip ahead to Check Current Branch. If you're building a featured branch, following these steps to copy the branch name from the Loopkit/LoopWorkspace repository will minimize typographical errors.
1. Go to https://github.com/LoopKit/LoopWorkspace/branches
2. Click the copy button next to the branch you'd like to build. The branch name is now in your paste buffer.

### Check Current `Branch`

Your `LoopWorkspace fork` is at `https://github.com/username/LoopWorkspace` where you substitute your actual *GitHub* `username`. You need to be logged into *GitHub*. Review the graphic below as you go through the steps.
Your `LoopWorkspace fork` is at `https://github.com/username/LoopWorkspace/branches` where you substitute your actual *GitHub* `username`. You need to be logged into *GitHub*. Review the graphic below as you go through the steps.

1. Click on the `branch` icon to display the `branches` as shown in the lower half of the graphic below:
* If the `branch` you want is not listed, then continue with Step 2
1. If the `branch` you want is not listed, then continue with Step 2
* Otherwise, skip ahead to [Update `Branch`](#update-branch)
1. Click on the `New branch` button and follow the [Add `Branch`](#add-branch) steps
2. Click on the `New branch` button and follow the [Add `Branch`](#add-branch) steps

![steps to add a branch](img/add-branch-01.svg){width="700"}
{align="center"}
Expand All @@ -47,7 +51,7 @@ Each step in the list below matches with the number in the graphic. In the top h

1. Click on the drop down menu labeled 1 in the graphic and choose LoopKit/LoopWorkspace as show in the top right graphic
2. Click on the drop down menu labeled 2 in the graphic and choose `dev`
3. Click on the `Branch` name box labeled 3 in the graphic and type `dev`
3. Click on the `Branch` name box labeled 3 in the graphic and type `dev`or paste from your buffer.
* The branch name in your `fork` should always match the branch name you are adding; check that you type it correctly
4. Review the dialog items to make sure everything is correct and then tap on Create branch

Expand Down