Skip to content

Commit

Permalink
Merge pull request #50 from Sarafian/49-publish-new-version
Browse files Browse the repository at this point in the history
Prepared 1.10 with minor corrections
  • Loading branch information
Sarafian authored Jun 10, 2024
2 parents 7f1041c + 6ee29ac commit 140e68d
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
10 changes: 6 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
**v1.10** *In progress*
**v1.11** Placeholder

**v1.10** 20240610
- GH-28 Added new command `New-MDAlert` for GFM Alerts. Thanks to @belibug
- GH-42 Fixed a bug with the left alignment of columns with `New-MDTable`. Thanks to @aaronparker

**v1.9** *20200227*
**v1.9** 20200227
- Based on GH-20 the default output of `New-MDTable` has a cell length alignment per column. New parameter `-Shrink` is added to reduce the overall size and each cell is not padded. Thanks to @al-cheb

**v1.6** *20160420*
**v1.6** 20160420
- Fixed published manifest file which broke the 1.5 module.
- No code changes.

**v1.5** *20160420*
**v1.5** 20160420
- GH-17 thanks to @Wav3
- Removed from the manifest the `PowerShellHostVersion` because it created some issues with *in-remoting* like sessions.

Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ When adding or modifying existing functionality of the module, please consider t
For more inspiration please look into the `New-MDQuote`, `New-MDAlert` and `New-MDTable` for ever increasing complexity.
- The cmdlets are reasonably well documented and this level is expected to maintained. If the function refers to a specific non-standard function like the `New-MDAlert` then please do make sure to provide the link in the `Description` that would also help explain what the parameters do. In this case, you can also use those examples as text with the cmdlet's examples.
- There is a [Showcase] folder with [Showcase.ps1] that demonstrates the usage of the cmdlets. Its markdown output is demostrated in the [Showcase.md] for easy visualization which **is not to be edited directly**. Instead execute the [Update-Showcase.ps1] to render and same the content before submitting a pull request.
- Make sure to include your changes in the [CHANGELOG.md] under the `In progress` section at the top. Please mention your name/id as the contributor. The versioning and publishing scheme is explained further below.
- Make sure to include your changes in the [CHANGELOG.md] under the `Placeholder` section at the top. Please mention your name/id as the contributor. The versioning and publishing scheme is explained further below.

# Non functional changes

Expand All @@ -35,14 +35,14 @@ There is no manifest file. All the respected data is in the `.psm1` file which h

# Versioning scheme

If there are no breaking changes then the minor version will increment. The version is in the module's `.psm1` file and should not be changed as part of the pull request. All changes are mentioned in the [CHANGELOG.md] under the `In progress` version.
If there are no breaking changes then the minor version will increment. The version is in the module's `.psm1` file and should not be changed as part of the pull request. All changes are mentioned in the [CHANGELOG.md] under the `Placeholder` version.

# Publishing a new version

When the new version is ready

1. Create new branch with respected pull request.
2. Modify the version and [CHANGELOG.md] to align with the new version. Make sure that there is a `**v1.Next Minor** *In progress*` section in the top empty.
2. Modify the version and [CHANGELOG.md] to align with the new version. Make sure that there is a `**v1.Next Minor** Placeholder` section in the top empty.
3. Merge to `master`. This trigger the automatic execution of the publish function from AppVeyor.
4. Tag and create a new release by copying the section from the [CHANGELOG.md].

Expand Down
2 changes: 1 addition & 1 deletion Src/Modules/MarkdownPS/MarkdownPS.psm1
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"RootModule"="MarkdownPS.psm1"
"Description"="PowerShell module for Semantic Version"
"Guid"="c1e7cbac-9e47-4906-8281-5f16471d7ccd"
"ModuleVersion"="1.9"
"ModuleVersion"="1.10"
# Optional fields
"Author"="Alex Sarafian"
# "CompanyName" = "Company name"
Expand Down

0 comments on commit 140e68d

Please sign in to comment.