Skip to content

Commit 9d92fee

Browse files
committed
Update module description for new version
* Add new section in CONTRIBUTING for new feature and release
1 parent f4e92bb commit 9d92fee

File tree

2 files changed

+47
-1
lines changed

2 files changed

+47
-1
lines changed

CONTRIBUTING.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,49 @@ Some general guidelines:
3232
contain the error message
3333
* Add Pester tests for new functionality in .\tests\Pester\
3434
* Register the feature to the `$Repository` variable (see PowerSponse.psm1)
35+
36+
## Adding a new feature
37+
38+
1. Implement feature in respect to the guidelines mentioned above.
39+
1. Add corresponding Pester tests where useful in /test/Pester.
40+
1. Add the name of a new cmdlet which is used by the users to the
41+
**Export-ModuleMember** list at the end of the module file (.psm1).
42+
1. Add the name of a new cmdlet to the **FunctionsToExport** list in the module
43+
description file (.psd1).
44+
1. Add relevant notes to the [CHANGELOG](CHANGELOG.md).
45+
1. Add a new markdown help file in /docs with examples. See [BUILD](BUILD.md)
46+
for information about generating the help file.
47+
1. Add new markdown help file to the overview in /docs/PowerSponse.md.
48+
1. Update the external help file. See [BUILD](BUILD.md) for
49+
information about generating the help file.
50+
1. Update README if needed.
51+
1. Update tag file if needed. See [BUILD](BUILD.md) for
52+
information about generating the tag file.
53+
54+
## Making a new Release
55+
56+
1. Update markdown help and external help file.
57+
1. Run the Pester tests. See [BUILD](BUILD.md). All tests must pass.
58+
1. Update CHANGELOG
59+
* Update information according to the current release.
60+
* Add new **Unreleased** section and update the link for comparison.
61+
* Add the new version number in the old unreleased section.
62+
* Add the version comparison link to the current release changelog section.
63+
* Add the current date at the end of the new header row
64+
1. Update **ModuleVersion** in the module description file (.psd1).
65+
1. Commit the changes
66+
1. Set a tag for the new version (e.g. "vx.x.x").
67+
1. Push the tag and the code changes to the repo.
68+
1. Add a new Github release and add release notes
69+
1. Publish the new module version to PowerShell gallery
70+
* Make a clean folder for PowerSponse in the module path.
71+
* Add the psm1, psd1 and the external help (en-us) to that PowerSponse module
72+
folder.
73+
* Run the following command to publish the module to the PowerShell gallery.
74+
``` powershell
75+
Publish-Module -Name PowerSponse -NuGetApiKey <apiKey>
76+
```
77+
1. Update release notes in PowerShellGallery
78+
79+
The module is currently located at https://www.powershellgallery.com/packages/PowerSponse.
80+

PowerSponse.psd1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
RootModule = 'PowerSponse.psm1'
1313

1414
# Version number of this module.
15-
ModuleVersion = '0.1.0'
15+
ModuleVersion = '0.2.0'
1616

1717
# ID used to uniquely identify this module
1818
GUID = 'ca85e27c-3d41-49a1-9315-fb44966836b7'

0 commit comments

Comments
 (0)