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
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,14 +6,16 @@ A workflow for crafting PowerShell modules using the PSModule framework, which b
6
6
7
7
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).
8
8
1. Configure the repository:
9
-
1. Enable GitHub Pages in the repository settings. Set it to deploy from `GitHub Actions`.
10
-
1. This will create an environment called `github-pages` that GitHub deploys your site to.
11
-
<details><summary>Within the environment, remove the branch protection for <code>main</code>.</summary>
9
+
1. Enable GitHub Pages in the repository settings. Set it to deploy from **GitHub Actions**.
10
+
1. This will create an environment called **github-pages** that GitHub deploys your site to.
11
+
<details><summary>Within the **github-pages** environment, remove the branch protection for <code>main</code>.</summary>
12
12
<imgsrc="./media/pagesEnvironment.png"alt="Remove the branch protection on main">
13
13
</details>
14
-
1.[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.
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
15
1. Create a new secret in the repository called `APIKEY` and set it to the API key for the PowerShell Gallery.
16
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.
0 commit comments