Skip to content

Latest commit

 

History

History
50 lines (38 loc) · 2.51 KB

DEVELOPMENT.md

File metadata and controls

50 lines (38 loc) · 2.51 KB
Raw

Development

This file provides additional information for maintainers and contributors.

Testing

Nothing special or automated yet. For the time being, try at least:

  1. Build the nupkg package, install it and watch out for errors and warnings: 
    cd ./chocolatey-sendkeys.extension
choco pack
choco install sendkeys.extension --source='.\' --force
RefreshEnv
  2. Import the PowerShell module directly, do some function calls and watch out for errors. See the README.md "Usage" section for details.

Releases

  1. Do proper Testing. Continue only if everything is fine.
  2. Determine the next version number. This project adheres to Semantic Versioning. Unlike other Chocolatey packages, there is no underlying software's version to match.
  3. Update the CHANGELOG.md. Insert a section for the new release. Do not forget the comparison link at the end of the file.
  4. If everything is fine: commit the changes, tag the release and push: 
    git tag v<version> <commit> -m "version <version>"
git show v<version>
git push origin main --follow-tags
    If something minor went wrong (like missing CHANGELOG.md update), delete the tag and start over: 
    git tag -d v<version>                 # delete the old tag locally
git push origin :refs/tags/v<version> # delete the old tag remotely
    This is only possible if the package was not already pushed to the community package feed. Use a new patch version number otherwise.
  5. Pack the .nupkg and push it to the community package feed: 
    choco pack
choco apikey add -s "https://push.chocolatey.org/" -k="..."
choco push sendkeys.extension.<version>.nupkg --source "https://push.chocolatey.org/"

Miscellaneous

Encoding

  • Generally: Use UTF-8 encoding with LF (Line Feed \n) line endings.
  • All *.ps1, psm1 and *.nuspec files: Please follow Chocolatey's character encoding rules. Add a Byte Order Mark (BOM) and use CRLF (Carriage Return \r and Line Feed \n) line endings as Chocolatey's general context is Microsoft Windows, Powershell and .NET.