Skip to content

Contributing.md

Latest commit

 

History

History
34 lines (24 loc) · 2.03 KB

Contributing.md

File metadata and controls

34 lines (24 loc) · 2.03 KB

Contributing to this project

Feel free to open an issue or pull request.

🚀 Publishing new versions

A prerelease version of the module is published automatically on every commit to the main branch. The GitHub Actions deploy workflow run must be manually approved to publish a stable version.

Incrementing the version number

The version number is of the format Major.Minor.Patch and follows semantic versioning. By default, every commit to the main branch will increment the Patch version number.

If you want to increment the Major or Minor version number, you have 2 options:

  1. Manually start a deploy workflow run and specify the version number to use. e.g. Specifying 2.4.0 will produce a new version of 2.4.0.
  2. Create a new version tag and pushing it up to GitHub. Builds are not triggered on tags, and thus the version tag will be used as the starting point for the next version. e.g. Creating a new tag of v2.4.0 will produce a new version of 2.4.1 on the next commit to the main branch.

Updating Dumpify

To update the version of Dumpify that the PowerShell module uses:

  1. Download the latest Dumpify NuGet package to your computer.
  2. Rename the .nupkg file to .zip and extract the contents.
  3. Copy the lib\netstandard2.0\Dumpify.dll to src/dumPS/Dumpify/<new version>/netstandard2.0/Dumpify.dll.
  4. Inspect the Dumpify.nuspec file to see which version of Spectre.Console it depends on.
  5. Download that specific version of the Spectre.Console NuGet package to your computer.
  6. Rename the .nupkg file to .zip and extract the contents.
  7. Copy the lib\netstandard2.0\Spectre.Console.dll to src/dumPS/Dumpify/<new version>/netstandard2.0/Spectre.Console.dll.
  8. Delete the src/dumPS/Dumpify/<old version> directory.