Skip to content

Commit 5482582

Browse files
authored
docs: add readme details
1 parent bc9d74d commit 5482582

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,10 @@ permissions:
9797
contents: write
9898
```
9999

100+
101+
> [!NOTE]
102+
> 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 there select the branch you supplied to the action, in most cases this will be `gh-pages` as that's the default.
103+
100104
## Configuration 📁
101105

102106
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).

0 commit comments

Comments
 (0)