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
+2-48Lines changed: 2 additions & 48 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -60,61 +60,15 @@ For information that can not be updated automatically, perform the following act
60
60
61
61
1. Search for `UPDATE ME` in the repository and update the file accordingly.
62
62
63
-
### ➕ Step 3: Add your module
64
-
65
-
If you already have a module written, add the module's `.psm1` and `.psd1` files to the `src` directory, replacing the existing files.
66
-
67
-
<!-- 1. Add your module to the `src` directory.
68
-
1. If you already have a module written:
69
-
1. Add the `.psm1` and `.psd1` files directly to the `src` directory.
70
-
1. Delete the `Template.PowerShell.ScriptModule.psm1` and `Template.PowerShell.ScriptModule.psd1` files from the `src` directory.
71
-
1. If you have not written the module yet:
72
-
1. Rename the `Template.PowerShell.ScriptModule.psm1` and `Template.PowerShell.ScriptModule.psd1` files in the `src` directory to match your module name.
73
-
1. Perform a find-and-replace across the entire repository to replace `Template.PowerShell.ScriptModule` with your module's name (no spaces). -->
74
-
75
-
### 🚀 Step 4: Update your CI/CD workflows
76
-
77
-
This template includes CI/CD workflows for building and publishing the PowerShell module using both GitHub Actions and Azure DevOps Pipelines.
78
-
Follow the instructions for the CI/CD system you plan to use.
79
-
80
-
#### 🐙🐱 GitHub Actions
81
-
82
-
If using GitHub Actions for your CI/CD workflows, perform the following steps:
83
-
84
-
#### ♻️ Azure DevOps Pipelines
85
-
86
-
If using Azure DevOps Pipelines for your CI/CD pipelines, perform the following steps:
87
-
88
-
### ✔ Step 5: Review and update boilerplate repo files
89
-
90
-
The following boilerplate git repository files should be reviewed and updated or removed.
91
-
92
-
Will require changes:
93
-
94
-
-[License](/License.md): Update to match your module's license, and ensure it uses the correct name in the copyright.
95
-
-[CODEOWNERS](/.github/CODEOWNERS): Update to match your module's maintainers, or remove this file.
96
-
-[FUNDING](/.github/FUNDING.yml): Update to match your module's donation information, or remove this file.
97
-
-[ReadMe](/ReadMe.md): Update with your module's information.
98
-
99
-
May require changes:
100
-
101
-
- Module manifest: Update the module manifest (the `.psd1` file in the `src` directory) with your module's information.
102
-
-[Changelog](/Changelog.md): If you don't plan to track a changelog, remove this file and it's reference from the ReadMe.
103
-
-[Contributing](/docs/Contributing.md): Update to match your module's contributing guidelines, or remove it.
104
-
-[Architectural Decision Records](/docs/ArchitectureDecisionRecords/): Remove this directory if you don't plan to use ADRs, and it's reference from the Contributing page.
105
-
-[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 the bug report, feature request, and pull request templates as needed to meet your requirements, or remove them.
106
-
- Build and deployment workflows: The workflows include extra steps that you may not want, such as spell check, code coverage, etc.
107
-
Review the workflows and remove any steps that you don't want to include in your CI/CD pipeline.
108
-
109
-
### 📋 Step 6 (optional): Create your own template
63
+
## 📋 Create your own template (optional)
110
64
111
65
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.
112
66
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`.
113
67
114
68
The caveat here is you have already ran the script that updated the repository files with your module's name and other information.
115
69
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.
116
70
117
-
###❤ Step 7 (optional): Donate to support this template
71
+
## ❤ Donate to support this template (optional)
118
72
119
73
Buy me a hot apple cider for providing this template open source and for free 🙂
Otherwise, use these files as a starting point for your new module.
21
+
22
+
### 🚀 Step 4: Update your CI/CD workflows
23
+
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
+
#### 🐙🐱 GitHub Actions
28
+
29
+
If using GitHub Actions for your CI/CD workflows, perform the following steps:
30
+
31
+
#### ♻️ Azure DevOps Pipelines
32
+
33
+
If using Azure DevOps Pipelines for your CI/CD pipelines, perform the following steps:
34
+
35
+
### ✔ Step 5: Review and update boilerplate repo files
36
+
37
+
The following boilerplate git repository files should be reviewed and updated or removed.
38
+
39
+
Will require changes:
40
+
41
+
-[License](/License.md): Update to match your module's license, and ensure it uses the correct name in the copyright.
42
+
-[CODEOWNERS](/.github/CODEOWNERS): Update to match your module's maintainers, or remove this file.
43
+
-[FUNDING](/.github/FUNDING.yml): Update to match your module's donation information, or remove this file.
44
+
-[ReadMe](/ReadMe.md): Update with your module's information.
45
+
46
+
May require changes:
47
+
48
+
- Module manifest: Update the module manifest (the `.psd1` file in the `src` directory) with your module's information.
49
+
-[Changelog](/Changelog.md): If you don't plan to track a changelog, remove this file and it's reference from the ReadMe.
50
+
-[Contributing](/docs/Contributing.md): Update to match your module's contributing guidelines, or remove it.
51
+
-[Architectural Decision Records](/docs/ArchitectureDecisionRecords/): Remove this directory if you don't plan to use ADRs, and it's reference from the Contributing page.
52
+
-[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 the bug report, feature request, and pull request templates as needed to meet your requirements, or remove them.
53
+
- Build and deployment workflows: The workflows include extra steps that you may not want, such as spell check, code coverage, etc.
54
+
Review the workflows and remove any steps that you don't want to include in your CI/CD pipeline.
55
+
56
+
> [!IMPORTANT]
57
+
> If you've made it this far, your repository is now ready for use! 🎉
58
+
> You may delete all of the content above and commit any changes you've made.
0 commit comments