Skip to content

Commit 6c7b6b5

Browse files
committed
docs: Update setup instructions
1 parent a0c80f6 commit 6c7b6b5

File tree

2 files changed

+25
-10
lines changed

2 files changed

+25
-10
lines changed

ReadMe.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ A template repository and module for creating new PowerShell module repos quickl
66

77
## ✨ Features
88

9-
Use this template/module for your new git repository to get the following features out-of-the-box:
9+
Use this template or module for your new git repository to get the following features out-of-the-box:
1010

1111
- GitHub Actions workflows or Azure DevOps Pipelines YAML files that:
1212
- Publish a prerelease version on every commit to the `main` branch, and a stable version once manually approved.

src/Template.PowerShell.ScriptModule/TemplateRepoFiles/ReadMe.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
> [!IMPORTANT]
44
> Congratulations on initializing your repository! 🎉
5+
>
56
> 🚧 You are not quite done yet though. 🚧
7+
>
68
> Complete the following steps to finish setting up your repository.
79
810
## 📄 Template setup instructions
@@ -21,19 +23,19 @@ Otherwise, use these files as a starting point for your new module.
2123

2224
### 🚀 Step 4: Update your CI/CD workflows
2325

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
2827

2928
In order to publish the module to the gallery, you need to get an API key.
3029
If you already have an API key that you want to use, you can skip to the next step.
3130

32-
> [!TIP]
31+
> [!CAUTION]
3332
> It is considered best practice to use a separate API key for each module you publish.
3433
> It reduces the impact scope if one of the API keys becomes compromised.
3534
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>
3739

3840
1. Navigate to <https://www.powershellgallery.com/account/apikeys>, and login if necessary.
3941
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:
4446
1. Click the `Create` button to create the API key.
4547
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.
4648

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>
4858

4959
If using GitHub Actions for your CI/CD workflows, perform the following steps to setup your API key as a repository secret:
5060

@@ -67,17 +77,22 @@ Next we want to create an Environment so that stable module versions require man
6777
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.
6878
You will instead need to use [the Manual Workflow Approval action](https://github.com/marketplace/actions/manual-workflow-approval).
6979

70-
#### Azure DevOps Pipelines
80+
</details>
81+
82+
<details>
83+
<summary>Click to see Azure DevOps setup instructions...</summary>
7184

7285
Coming soon.
7386

87+
</details>
88+
7489
### ✔ Step 5: Review and update boilerplate repo files
7590

7691
The following boilerplate git repository files should be reviewed and updated or removed as needed.
7792

7893
- [__NewModuleName__.psd1](/src/__NewModuleName__/__NewModuleName__.psd1): Update the module manifest with your module's information.
7994
- [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.
8196
- [Contributing](/docs/Contributing.md): Update to match your module's contributing guidelines, or remove it.
8297
- [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.
8398
- Build and deployment workflows: The workflows include extra steps that you may not want, such as spell check, code coverage, etc.

0 commit comments

Comments
 (0)