@oat-sa/tao-extension-release

tao-extension-release

This tool automates TAO extension release

Installation

Please verify installation prerequisite. And run :

npm i -g @oat-sa/tao-extension-release

Release

This tool offers specialized release process for different types of repositories.

TAO extensions

If the repository contains a TAO Extension, please use the command extensionRelease.

taoRelease extensionRelease

You will be prompted to follow the instructions.

This command does:

• compute the next version from commits
• bundle assets
• create a tag and a release

NPM packages

If the repository contains an npm package, please use the command npmRelease. This command must be run in the root directory of an npm package repository.

cd path/to/my/package/repo
taoRelease npmRelease

You will be prompted to follow the instructions.

This command does:

• compute the next version from commits
• update the package.json and package-lock.json
• create a tag and a release
• publish the package to npm

At then end, you will be prompted to trigger the execution of npm publish. The Github release is already finished at this stage. If the publish step fails, you can try again manually, or ask someone with the necessary privileges to perform the publishing.

NPM packages in monorepo

If the repository is a lerna-managed monorepo, and contains npm packages, please use the command npmReleaseMonorepo. This command must be run in the root directory of the monorepo. Monorepo must be have lerna installed at the root, because release tool will use its CLI to get infromation about packages.

cd path/to/my/package/repo
taoRelease npmReleaseMonorepo

This command does:

• compute the next version from commits
  • for root, and for each package. Based on commits that touch files in this package.
• update the package.json and package-lock.json
  • for root, and for each package
• create a tag and a release
• publish the packages to npm
  • the Github release is already finished at this stage. If the publish step fails, you can try again manually, or ask someone with the necessary privileges to perform the publishing.

Tag based repositories

For any other repository that doesn't need any special build but only tagging and merging, like PHP libraries, please use the command repoRelease. This command must be run in the root directory of the repository.

cd path/to/my/repo
taoRelease repoRelease

You will be prompted to follow the instructions.

This command does:

• compute the next version from commits
• create a tag and a release

Commandline arguments

Commandline arguments to give you more control over the parameters of the release:

Common options

option	description	default
--base-branch <branch>	branch to release from	develop
--branch-prefix <prefix>	releasing branch prefix	release
--origin <remote>	git repository remote name	origin
--release-branch <branch>	branch to release to	master
--release-version <version>	version to be used for the release	version extracted from conventional commits
--release-comment <comment>	comment to attach to the release	(none - prompted)
--no-interactive	turns off the interactive mode	interactive mode is on by default, except on non TTY shells
--no-write	turns off writting config to file system	no set

extensionRelease extra options

option	description	default
--path-to-tao <path>	relative or absolute filesystem path	(none - prompted)
--extension-to-release <extension>	extension name (e.g. taoFoobar)	(none - prompted)
--update-translations	run translation update without prompting. Translations update is only available in interative mode.
--www-user <user>	the system user used to launch PHP commands	www-data

npmReleaseMonorepo extra options

option	description	default
--release-tag	tag to be used for the release, if it's different from root package.json version
--conventional-bump-type	one of: none,patch, minor, major. If not specified, will be calculated from conventional commits on each package. If none, will not change package versions.
--no-publish	do not publish packages to npm. Publishing is done as the last step. For no-interactive mode.

Development

Remove the package if already installed globally :

npm uninstall -g @oat-sa/tao-extension-release

Then clone the sources :

git clone [e-mail]:oat-sa/tao-extension-release.git
cd tao-extension-release
npm install
npm link

So the command taoRelease will use the sources.

Useful commands :

• npm test runs the test suite
• npx jest -- my-test.spec.js runs a single test
• npm run test:cov runs the test suite with code coverage
• npm run test:dev runs the test suite in watch mode
• npm run lint verifies the sources complies with the code style guide

Configuration

A file named .tao-extension-release is created in the user directory. The following values can be defined in this file :

• token : your Github auth token
• taoRoot : the path to the root of TAO
• wwwUser : the system user used to launch PHP commands (www-data)

Next version calculation

Next version taken based on Conventional commits. Some treats of the next version calculation:

• if one or more commits contains a breaking change, the version will be increased by one major semver version
• if one or more commits contains a feature change, the version will be increased by one minor semver version
• if one or more commits contains a bugfix change, the version will be increased by one fix semver version
• if no commit contains a conventional change information, the version will be increased by one fix semver version and warn the user
• if release-version option provided, it will be taken as next release version and version calculation will be skipped

System Prerequisite

node.js

You need a recent version of node.js for your platform.

git

You need to have the git > 1.7.0 command available in your PATH.

PHP

To release TAO extension, you may also need the php command available in your PATH

sudo (linux and OSX)

You also need the sudo command available in your PATH.

Known Issues

Task foosass not found

Everything looks OK but you don't know why the grunt task is not found. If you have updated node or npm recently, you can fix this by :

cd tao/views/build
npm reinstall node-sass --force

Release notes

See the history

License

Copyright (c) 2017-2021 Open Assessment Technologies SA; GNU General Public License v2.0