Skip to content

Commit a5e468a

Browse files
🔧 [Docs]: Clarify instructions for GitHub Pages environment setup and branch protection removal
1 parent 220404e commit a5e468a

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ Process-PSModule follows:
1818
This will create a new repository with the same structure as the PSModule organization.
1919
2. Configure the repository:
2020
1. Enable GitHub Pages in the repository settings. Set it to deploy from `GitHub Actions`.
21-
This will create an environment called `github-pages` that is used to deploy the documentation to GitHub Pages. Remove the branch protection on it.
21+
This will create an environment called `github-pages` that is used to deploy the documentation to GitHub Pages.
22+
Within the environment, remove the branch protection for `main`.
2223
2. [Create an API key on the PowerShell Gallery](https://www.powershellgallery.com/account/apikeys). Give it enough permission to manage the module you are working on.
2324
3. Create a new secret in the repository called `APIKEY` and set it to the API key for the PowerShell Gallery.
2425
3. Create a branch, make your changes, create a PR and let the workflow run.

0 commit comments

Comments
 (0)