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
+9-6Lines changed: 9 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,7 @@
1
1
# Process-PSModule
2
2
3
-
A workflow for crafting PowerShell modules using the PSModule framework, which builds, tests, and publishes PowerShell modules to the PowerShell Gallery and produces documentation that is published to GitHub Pages. The workflow is used by all PowerShell modules in the PSModule organization.
3
+
A workflow for crafting PowerShell modules using the PSModule framework, which builds, tests, and publishes PowerShell modules to the PowerShell
4
+
Gallery and produces documentation that is published to GitHub Pages. The workflow is used by all PowerShell modules in the PSModule organization.
4
5
5
6
## How to get started
6
7
@@ -11,11 +12,13 @@ A workflow for crafting PowerShell modules using the PSModule framework, which b
11
12
<details><summary>Within the **github-pages** environment, remove the branch protection for <code>main</code>.</summary>
12
13
<imgsrc="./media/pagesEnvironment.png"alt="Remove the branch protection on main">
13
14
</details>
14
-
1.[Create an API key on the PowerShell Gallery](https://www.powershellgallery.com/account/apikeys). Give it permission to manage the module you are working on.
15
-
1. Create a new secret in the repository called `APIKEY` and set it to the API key for the PowerShell Gallery.
16
-
1. Create a branch, make your changes, create a PR and let the workflow run.
17
-
1.**After merge:** The workflow automatically builds, tests, and publishes your module to the PowerShell Gallery and updates the documentation on GitHub Pages.
18
-
By default the process releases a patch version, which you can change by applying labels like `minor` or `major` on the PR to bump the version accordingly.
15
+
1.[Create an API key on the PowerShell Gallery](https://www.powershellgallery.com/account/apikeys). Give it permission to manage the module you
16
+
are working on.
17
+
2. Create a new secret in the repository (or organization) called `APIKEY` and set it to the API key for the PowerShell Gallery.
18
+
2. Create a branch, make your changes, create a PR and let the workflow run.
19
+
3. When merging to `main`, the workflow automatically builds, tests, and publishes your module to the PowerShell Gallery and updates the documentation
20
+
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
0 commit comments