Skip to content

Commit fb81954

Browse files
docs(readme): add important note on removing branch protection for GitHub Pages deployment
1 parent 9d5a073 commit fb81954

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,11 @@ projects.
1212
1. Configure the repository:
1313
1. Enable GitHub Pages in the repository settings. Set it to deploy from **GitHub Actions**.
1414
1. This will create an environment called `github-pages` that GitHub deploys your site to.
15+
1516
> [!IMPORTANT]
1617
> Within the **github-pages** environment, remove the branch protection for `main`
1718
> ![Remove the branch protection on main](./media/pagesEnvironment.png)
19+
1820
2. [Create an API key on the PowerShell Gallery](https://www.powershellgallery.com/account/apikeys). Give it permission to manage the module you
1921
are working on.
2022
3. Create a new secret in the repository called `APIKEY` and set it to the API key for the PowerShell Gallery.

0 commit comments

Comments
 (0)