You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,17 +13,18 @@ modules in the [PSModule organization](https://github.com/PSModule), ensuring re
13
13
1.[Create a repository from the Template-Module](https://github.com/new?template_name=Template-PSModule&template_owner=PSModule&description=Add%20a%20description%20(required)&name=%3CModule%20name%3E).
14
14
1. Configure the repository:
15
15
1. Enable GitHub Pages in the repository settings. Set it to deploy from **GitHub Actions**.
16
-
1. This will create an environment called **github-pages** that GitHub deploys your site to.
16
+
1. This will create an environment called `github-pages` that GitHub deploys your site to.
17
17
<details><summary>Within the **github-pages** environment, remove the branch protection for <code>main</code>.</summary>
18
18
<imgsrc="./media/pagesEnvironment.png"alt="Remove the branch protection on main">
19
19
</details>
20
20
1.[Create an API key on the PowerShell Gallery](https://www.powershellgallery.com/account/apikeys). Give it permission to manage the module you
21
21
are working on.
22
-
2. Create a new secret in the repository (or organization) called `APIKEY` and set it to the API key for the PowerShell Gallery.
23
-
2. Create a branch, make your changes, create a PR and let the workflow run.
24
-
3. When merging to `main`, the workflow automatically builds, tests, and publishes your module to the PowerShell Gallery and updates the documentation
25
-
on GitHub Pages. By default the process releases a patch version, which you can change by applying labels like `minor` or `major` on the PR to bump
26
-
the version accordingly.
22
+
1. Create a new secret in the repository called `APIKEY` and set it to the API key for the PowerShell Gallery.
23
+
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.
24
+
1. Clone the repo locally, create a branch, make your changes, push the changes, create a PR and let the workflow run.
25
+
1. When merging to `main`, the workflow automatically builds, tests, and publishes your module to the PowerShell Gallery and maintains the
26
+
documentation on GitHub Pages. By default the process releases a patch version, which you can change by applying labels like `minor` or `major` on
0 commit comments