Skip to content

Commit

Permalink
docs: adjust placement
Browse files Browse the repository at this point in the history
  • Loading branch information
JamesIves committed May 13, 2024
1 parent be62bf6 commit 54287c5
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,9 @@ jobs:
folder: build # The folder the action should deploy.
```

> [!NOTE]
> You must configure your repository to deploy from the branch you push to. To do this, go to your repository settings, click on `Pages`, and choose `Deploy from a Branch` from the `Source` dropdown. From there select the branch you supplied to the action, in most cases this will be `gh-pages` as that's the default.
If you'd like to make it so the workflow only triggers on push events to specific branches then you can modify the `on` section.

```yml
Expand All @@ -97,10 +100,6 @@ permissions:
contents: write
```


> [!NOTE]
> You must configure your repository to deploy from the branch you push to. To do this, go to your repository settings, click on `Pages`, and choose `Deploy from a Branch` from the `Source` dropdown. From there select the branch you supplied to the action, in most cases this will be `gh-pages` as that's the default.
## Configuration 馃搧

The `with` portion of the workflow **must** be configured before the action will work. You can add these in the `with` section found in the examples above. Any `secrets` must be referenced using the bracket syntax and stored in the GitHub repository's `Settings/Secrets` menu. You can learn more about setting environment variables with GitHub actions [here](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets).
Expand Down

0 comments on commit 54287c5

Please sign in to comment.