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: src/Template.PowerShell.ScriptModule/TemplateRepoFiles/ReadMe.md
+24-9Lines changed: 24 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,9 @@
2
2
3
3
> [!IMPORTANT]
4
4
> Congratulations on initializing your repository! 🎉
5
+
>
5
6
> 🚧 You are not quite done yet though. 🚧
7
+
>
6
8
> Complete the following steps to finish setting up your repository.
7
9
8
10
## 📄 Template setup instructions
@@ -21,19 +23,19 @@ Otherwise, use these files as a starting point for your new module.
21
23
22
24
### 🚀 Step 4: Update your CI/CD workflows
23
25
24
-
This template includes CI/CD workflows for building and publishing the PowerShell module using both GitHub Actions and Azure DevOps Pipelines.
25
-
Follow the instructions for the CI/CD system you plan to use.
26
-
27
-
#### Create a PowerShell Gallery API Key
26
+
#### 🔑 Create a PowerShell Gallery API Key
28
27
29
28
In order to publish the module to the gallery, you need to get an API key.
30
29
If you already have an API key that you want to use, you can skip to the next step.
31
30
32
-
> [!TIP]
31
+
> [!CAUTION]
33
32
> It is considered best practice to use a separate API key for each module you publish.
34
33
> It reduces the impact scope if one of the API keys becomes compromised.
35
34
36
-
To create a new API Key for the PowerShell Gallery:
35
+
If you will be publishing the module to a custom PowerShell Gallery feed, you will need to get an API key for that feed. Otherwise, follow the steps below.
36
+
37
+
<details>
38
+
<summary>Click to view steps to create a new API Key for the PowerShell Gallery...</summary>
37
39
38
40
1. Navigate to <https://www.powershellgallery.com/account/apikeys>, and login if necessary.
39
41
1. Click `Create` to create a new API key for this module.
@@ -44,7 +46,15 @@ To create a new API Key for the PowerShell Gallery:
44
46
1. Click the `Create` button to create the API key.
45
47
1. Click the `Copy` button on the new API key to copy it to your clipboard, as you will need it for the next step.
46
48
47
-
#### GitHub Actions
49
+
</details>
50
+
51
+
#### ▶ GitHub Actions and Azure DevOps Pipelines setup instructions
52
+
53
+
Building and publishing the PowerShell module using GitHub Actions and Azure DevOps Pipelines are both supported.
54
+
Follow the instructions for the CI/CD platform you plan to use.
55
+
56
+
<details>
57
+
<summary>Click to see GitHub setup instructions...</summary>
48
58
49
59
If using GitHub Actions for your CI/CD workflows, perform the following steps to setup your API key as a repository secret:
50
60
@@ -67,17 +77,22 @@ Next we want to create an Environment so that stable module versions require man
67
77
If your account does not meet [the requirements to use `Environments`](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment), the `Environments` section will not be available.
68
78
You will instead need to use [the Manual Workflow Approval action](https://github.com/marketplace/actions/manual-workflow-approval).
69
79
70
-
#### Azure DevOps Pipelines
80
+
</details>
81
+
82
+
<details>
83
+
<summary>Click to see Azure DevOps setup instructions...</summary>
71
84
72
85
Coming soon.
73
86
87
+
</details>
88
+
74
89
### ✔ Step 5: Review and update boilerplate repo files
75
90
76
91
The following boilerplate git repository files should be reviewed and updated or removed as needed.
77
92
78
93
-[__NewModuleName__.psd1](/src/__NewModuleName__/__NewModuleName__.psd1): Update the module manifest with your module's information.
79
94
-[Changelog](/Changelog.md): If you don't plan to track a changelog, remove this file and it's reference from the ReadMe.
80
-
-[License](/License.md): Update to match your module's license, and ensure it uses the correct name in the copyright.
95
+
-[License](/License.md): Update to match your module's license, and ensure it uses the correct name and year in the copyright.
81
96
-[Contributing](/docs/Contributing.md): Update to match your module's contributing guidelines, or remove it.
82
97
-[bug_report](/.github/ISSUE_TEMPLATE/bug_report.md), [feature_request](/.github/ISSUE_TEMPLATE/feature_request.md), [pull_request_template](/.github/pull_request_template.md): Update these GitHub templates as needed to meet your requirements, or remove them.
83
98
- Build and deployment workflows: The workflows include extra steps that you may not want, such as spell check, code coverage, etc.
0 commit comments