Skip to content

Latest commit

 

History

History
113 lines (77 loc) · 7 KB

identifiers.md

File metadata and controls

113 lines (77 loc) · 7 KB

First Use of Actions Tab

Near the top middle of your LoopWorkspace  fork  is an Actions tab. This section provides detailed directions to enable Actions.

Click on the Actions tab of your LoopWorkspace repository.

  • Your first time, a message appears saying Workflows aren't being run on this forked repository as shown in the graphic below

  • Tap on the green button that says: I understand my workflows, go ahead and enable them

    workflows disabled screen{width="700"} {align="center"}

The workflows are now displayed on the left side as shown in the graphic below. (Dismiss the Actions Enabled message using the X near the upper right side if it appears).

workflows displayed{width="700"} {align="center"}

Validate Secrets

??? abstract "Section Summary (click to open/close)" This step validates most of your six Secrets and provides error messages if it detects an issue with one or more.

1. Click on the "Actions" tab of your LoopWorkspace repository and enable workflows if needed
1. On the left side, select `1. Validate Secrets`.
1. On the right side, click "Run Workflow", and tap the green `Run workflow` button.
1. Wait, and within a minute or two you should see a green checkmark indicating the workflow succeeded.
1. The workflow will check if the required <code>Secrets</code> are added and that they are correctly formatted. If errors are detected, please check the run log for details.

[<span class="loop-bigger">:material-skip-forward:</span>](#add-identifiers) To skip the detailed instructions, click on [<code>Add Identifiers</code>](#add-identifiers)

Near the top middle of your LoopWorkspace  fork, click on the Actions tab.

Refer to the graphic below for the numbered steps:

  1. Click on the Actions tab of your LoopWorkspace repository

  2. On the left side, click on 1. Validate Secrets

  3. On the right side, click Run Workflow to show a dropdown menu

    • You will see your default branch (typically this is main)
    • You can select a different branch, but typically, you run the default

  4. Tap the green button that says Run workflow.

    add identifiers using github actions{width="700"} {align="center"}

The Validate Secrets  Action  should succeed or fail in a few minutes. Do not continue to the next step until this one succeeds.

!!! tip "Hit Refresh" After you tap the green Run workflow button, GitHub can be slow to update.

* Refresh the browser if you are unsure if the action started
* Do not start a new action until the first one completes
  • If you see the green check (:octicons-check-circle-fill-16:{: .passed }) continue to the next section
  • If you see the red X (:octicons-x-circle-fill-16:{: .failed }):

!!! important "Ask For Help Early" Please if you are having trouble - ask for help early by clicking on this link{: target="_blank" }.

!!! tip "Pro Tip: Validate Secrets" The Action Validate Secrets is run every time you do any other action. Technically, you never have to run the action by itself - you could start with Add Identifiers.

It is easier for you (or your mentors) to diagnose if there is a problem with the `Secrets` you entered when it is run stand-alone. Once your secrets are good, they should remain good, so this does not need to be repeated.

Add Identifiers

!!! warning "Update to Version 3.4" The name and identifier for "Small Status Widget" was renamed to "Loop Widget Extension". If you previously built, you will need to run the Add Identifiers as directed on the update page{: target="_blank" } to add the renamed Identifier and Create Certificates for it.

If you previously built the `dev` branch, you already have this identifier.

??? abstract "Section Summary (click to open/close)" 1. Click on the "Actions" tab of your LoopWorkspace repository. 1. On the left side, select "2. Add Identifiers". 1. On the right side, click "Run Workflow", and tap the green Run workflow button. 1. Wait, and within a minute or two you should see a green checkmark indicating the workflow succeeded.

[<span class="loop-bigger">:material-skip-forward:</span>](prepare-app.md#configure-identifiers-for-loop){: target="_blank" } To skip the detailed instructions, click on [Configure Identifiers for Loop](prepare-app.md#configure-identifiers-for-loop){: target="_blank" }.

Refer to the graphic below for the numbered steps:

  1. Click on the Actions tab of your LoopWorkspace repository

  2. On the left side, click on 2. Add Identifiers

  3. On the right side, click Run Workflow to show a dropdown menu

    • You will see your default branch (typically this is main)
    • You can select a different branch, but typically, you run the default

  4. Tap the green button that says Run workflow.

    add identifiers using github actions{width="700"} {align="center"}

!!! tip "Be Patient" * Refresh the browser if you are unsure if the action started * Do not start a new action until the first one completes

The Add Identifiers  Action  should succeed or fail in a few minutes. Do not continue to the next step until this one succeeds.

  • If you see the green check (:octicons-check-circle-fill-16:{: .passed }) continue to the next section
  • If you see the red X (:octicons-x-circle-fill-16:{: .failed }):

!!! important "Ask For Help Early" Please if you are having trouble - ask for help early by clicking on this link{: target="_blank" }.

Next Step

The next step is to Prepare the App.