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
- Publish a prerelease version on every commit to the `main` branch, and the stable version once manually approved.
10
+
- Publish a prerelease version on every commit to the `main` branch, and a stable version once manually approved.
11
11
- Can also manually trigger deployments of feature branches.
12
12
- Version the module.
13
13
- Run PSScriptAnalyzer to ensure best practices are followed.
14
-
- Run tests on multiple platforms (Windows, Linux, MacOS).
14
+
- Run build tests, and smoke tests on multiple platforms (Windows, Linux, MacOS).
15
15
- Publish the module to the PowerShell Gallery or a custom feed.
16
16
- Spell check all files in the repository.
17
17
- Display test code coverage results on PRs.
@@ -24,7 +24,7 @@ Using this template for your git repository will provide the following features
24
24
Use this template to create a new repository for your PowerShell module.
25
25
Follow the instructions below to get started.
26
26
27
-
### 🗍 Create a new repo from this template
27
+
### 🗍 Step 1: Create a new repo from this template
28
28
29
29
The official docs for creating a new repository from a template can [be found here](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).
30
30
In short, the steps are:
@@ -35,7 +35,7 @@ In short, the steps are:
35
35
1. You should now have the new repository in your account with the name you chose.
36
36
1. Clone your new repository to your local machine to start making changes to it.
37
37
38
-
### 🤖 Replace repo template information
38
+
### 🤖 Step 2: Replace repo template information
39
39
40
40
Run the [_InitializeRepository.ps1](/_InitializeRepository.ps1) script to update the repository files with your module's information.
41
41
You will be prompted to enter the following information:
@@ -58,7 +58,7 @@ For information that can not be updated automatically, perform the following act
58
58
59
59
1. Search for `UPDATE ME` in the repository and update the file accordingly.
60
60
61
-
### ➕ Add your module
61
+
### ➕ Step 3: Add your module
62
62
63
63
If you already have a module written, add the module's `.psm1` and `.psd1` files to the `src` directory, replacing the existing files.
64
64
@@ -70,7 +70,7 @@ If you already have a module written, add the module's `.psm1` and `.psd1` files
70
70
1. Rename the `Template.PowerShell.ScriptModule.psm1` and `Template.PowerShell.ScriptModule.psd1` files in the `src` directory to match your module name.
71
71
1. Perform a find-and-replace across the entire repository to replace `Template.PowerShell.ScriptModule` with your module's name (no spaces). -->
72
72
73
-
### 🚀 Update your CI/CD workflows
73
+
### 🚀 Step 4: Update your CI/CD workflows
74
74
75
75
This template includes CI/CD workflows for building and publishing the PowerShell module using both GitHub Actions and Azure DevOps Pipelines.
76
76
Follow the instructions for the CI/CD system you plan to use.
@@ -83,7 +83,7 @@ If using GitHub Actions for your CI/CD workflows, perform the following steps:
83
83
84
84
If using Azure DevOps Pipelines for your CI/CD pipelines, perform the following steps:
85
85
86
-
### ✔ Update boilerplate repo files
86
+
### ✔ Step 5: Update boilerplate repo files
87
87
88
88
The following boilerplate git repository files should be reviewed and updated or removed.
89
89
@@ -104,21 +104,21 @@ May require changes:
104
104
- Build and deployment workflows: The workflows include extra steps that you may not want, such as spell check, code coverage, etc.
105
105
Review the workflows and remove any steps that you don't want to include in your CI/CD pipeline.
106
106
107
-
### 📋 Create your own template (optional)
107
+
### 📋 Step 6: Create your own template (optional)
108
108
109
109
Now that you have the repository looking the way you want, you may want to use it as a template for your future modules so that you don't have to make all of the same changes each time.
110
110
In GitHub, from the repo's `Settings` tab under the `General` section, you can rename the repository to reflect that it is a template and check the box to make it a `Template repository`.
111
111
112
112
The caveat here is you have already ran the script that updated the repository files with your module's name and other information.
113
113
In your template repo, you would want to add instructions to do a find-and-replace on the repository files to update the module's name, and any other information you want changed for new modules created from your template.
114
114
115
-
### ❤ Donate to support this template
115
+
### ❤ Step 7: Donate to support this template (optional)
116
116
117
117
Buy me a hot apple cider for providing this template open source and for free 🙂
0 commit comments