Skip to content

Commit

Permalink
Update module description for new version
Browse files Browse the repository at this point in the history
* Add new section in CONTRIBUTING for new feature and release
  • Loading branch information
Karneades committed Apr 2, 2019
1 parent f4e92bb commit 9d92fee
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 1 deletion.
46 changes: 46 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,49 @@ Some general guidelines:
contain the error message
* Add Pester tests for new functionality in .\tests\Pester\
* Register the feature to the `$Repository` variable (see PowerSponse.psm1)

## Adding a new feature

1. Implement feature in respect to the guidelines mentioned above.
1. Add corresponding Pester tests where useful in /test/Pester.
1. Add the name of a new cmdlet which is used by the users to the
**Export-ModuleMember** list at the end of the module file (.psm1).
1. Add the name of a new cmdlet to the **FunctionsToExport** list in the module
description file (.psd1).
1. Add relevant notes to the [CHANGELOG](CHANGELOG.md).
1. Add a new markdown help file in /docs with examples. See [BUILD](BUILD.md)
for information about generating the help file.
1. Add new markdown help file to the overview in /docs/PowerSponse.md.
1. Update the external help file. See [BUILD](BUILD.md) for
information about generating the help file.
1. Update README if needed.
1. Update tag file if needed. See [BUILD](BUILD.md) for
information about generating the tag file.

## Making a new Release

1. Update markdown help and external help file.
1. Run the Pester tests. See [BUILD](BUILD.md). All tests must pass.
1. Update CHANGELOG
* Update information according to the current release.
* Add new **Unreleased** section and update the link for comparison.
* Add the new version number in the old unreleased section.
* Add the version comparison link to the current release changelog section.
* Add the current date at the end of the new header row
1. Update **ModuleVersion** in the module description file (.psd1).
1. Commit the changes
1. Set a tag for the new version (e.g. "vx.x.x").
1. Push the tag and the code changes to the repo.
1. Add a new Github release and add release notes
1. Publish the new module version to PowerShell gallery
* Make a clean folder for PowerSponse in the module path.
* Add the psm1, psd1 and the external help (en-us) to that PowerSponse module
folder.
* Run the following command to publish the module to the PowerShell gallery.
``` powershell
Publish-Module -Name PowerSponse -NuGetApiKey <apiKey>
```
1. Update release notes in PowerShellGallery
The module is currently located at https://www.powershellgallery.com/packages/PowerSponse.
2 changes: 1 addition & 1 deletion PowerSponse.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
RootModule = 'PowerSponse.psm1'

# Version number of this module.
ModuleVersion = '0.1.0'
ModuleVersion = '0.2.0'

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

0 comments on commit 9d92fee

Please sign in to comment.