Skip to content

Commit 9e0fcd0

Browse files
docs(readme): improve clarity in API key setup instructions and reformat steps for consistency
1 parent 58b922a commit 9e0fcd0

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,12 @@ projects.
1717
</details>
1818
3. [Create an API key on the PowerShell Gallery](https://www.powershellgallery.com/account/apikeys). Give it permission to manage the module you
1919
are working on.
20-
4. Create a new secret in the repository called `APIKEY` and set it to the API key for the PowerShell Gallery.
21-
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.
22-
2. Clone the repo locally, create a branch, make your changes, push the changes, create a PR and let the workflow run.
23-
3. When merging to `main`, the workflow automatically builds, tests, and publishes your module to the PowerShell Gallery and maintains the
20+
4. Create a new secret called `APIKEY` in the repository and set the API key for the PowerShell Gallery as its value.
21+
5. If you are planning on creating many modules, you could use a glob pattern for the API key permissions in PowerShell Gallery and store the
22+
secret on the organization.
23+
3. Clone the repo locally, create a branch, make your changes, push the changes, create a PR and let the workflow run.
24+
- Adding a `Prerelease` label to the PR will create a prerelease version of the module.
25+
4. 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)