Skip to content

Commit 37349d0

Browse files
docs(readme): update instructions for GitHub Pages environment and correct numbering in setup steps
1 parent 91d20de commit 37349d0

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,17 @@ 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-
<details><summary>Within the <strong>github-pages</strong> environment, remove the branch protection for <code>main</code>.</summary>
15+
16+
<details><summary>Within the <code>github-pages</code> environment, remove the branch protection for <code>main</code>.</summary>
1617
<img src="./media/pagesEnvironment.png" alt="Remove the branch protection on main">
1718
</details>
18-
1. [Create an API key on the PowerShell Gallery](https://www.powershellgallery.com/account/apikeys). Give it permission to manage the module you
19+
20+
3. [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.
20-
1. Create a new secret in the repository called `APIKEY` and set it to the API key for the PowerShell Gallery.
21-
1. If you are planning on creating many modules, you could use a glob pattern for the API key permissions and store the secret on the organization.
22-
1. Clone the repo locally, create a branch, make your changes, push the changes, create a PR and let the workflow run.
23-
1. When merging to `main`, the workflow automatically builds, tests, and publishes your module to the PowerShell Gallery and maintains the
22+
4. Create a new secret in the repository called `APIKEY` and set it to the API key for the PowerShell Gallery.
23+
5. If you are planning on creating many modules, you could use a glob pattern for the API key permissions and store the secret on the organization.
24+
2. Clone the repo locally, create a branch, make your changes, push the changes, create a PR and let the workflow run.
25+
3. When merging to `main`, the workflow automatically builds, tests, and publishes your module to the PowerShell Gallery and maintains the
2426
documentation on GitHub Pages. By default the process releases a patch version, which you can change by applying labels like `minor` or `major` on
2527
the PR to bump the version accordingly.
2628

0 commit comments

Comments
 (0)