publish-utils

Installation

Add the files in HOST_PATH to your PATH

Github

For the github commands you need to set the environment variable PUBLISH_UTILS_GITHUB_TOKEN_FILE with the path to the file contains your github token (public_repo scope)

The github repository name is taken from .git/config

Commands

publish-utils-create-github-release

publish-utils-create-github-release /path/to/project

• Creates a new github release
  • The tag is publish-utils-get-release-tag
  • The title is publish-utils-get-release-title
  • The description is publish-utils-get-release-description
  • If the tag contains alpha, beta, pre or rc, it will marked as a pre release

publish-utils-get-release-changelog

publish-utils-get-release-changelog /path/to/project

Gets the current version entry from CHANGELOG.md

publish-utils-get-release-description

publish-utils-get-release-description /path/to/project

Gets publish-utils-get-release-changelog without header

publish-utils-get-release-tag

publish-utils-get-release-tag /path/to/project

Gets publish-utils-get-release-version with v

publish-utils-get-release-title

publish-utils-get-release-title /path/to/project

• Gets publish-utils-get-release-changelog header without tag
  • If no title, publish-utils-get-release-tag is used

publish-utils-get-release-version

publish-utils-get-release-version /path/to/project

Gets the current version file

publish-utils-tag-release

publish-utils-tag-release /path/to/project

• Creates a new git tag and push it
  • The tag is publish-utils-get-release-tag
  • The message is publish-utils-get-release-description

publish-utils-update-release-version

publish-utils-update-release-version /path/to/project

• Updates the version file to current date in format YYYY-MM-DD-I
  • If the version is already the current date, it will increase I, else I is 1
• Adds a new entry in CHANGELOG.md for the new version
  • If exists an entry for latest, it will take this as base for the version entry
  • Adds a new entry for latest (Replaces if latest exists)

publish-utils-upload-asset-to-github-release

publish-utils-upload-asset-to-github-release /path/to/project path/to/asset/in/project [asset-name]

• Upload an asset to github release
  • The release is from publish-utils-get-release-tag
  • If no asset name the basename of the asset path is used