Skip to content

Rename `assign` command to `request`
Compare
Choose a tag to compare
@mattpolzin mattpolzin released this 15 Jan 23:48
· 112 commits to main since this release
4.0.0
eddc43d
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

Changes

The way harmony used the word "assign" in commands, configuration options, and help text was often not aligned with the way GitHub uses that same word. Where Harmony used to say "assigned a reviewer" GitHub would say "requested a review;" since GitHub also has a totally distinct concept of assigning (assigning users to Pull Requests), this was regrettable naming for the Harmony CLI. I've changed the Harmony word choice going forward, though the commands and configuration options from prior versions of Harmony will continue to work for the duration of the 4.x releases.

Non-breaking

  • The assign command has been renamed to request; assign will continue to work with a deprecation warning for the duration of the 4.x releases in order to ease the transition to using the new name.
  • The assignTeams and assignUsers configuration options were renamed requestTeams and requestUsers respectively. The old config names will continue to work for the duration of the 4.x releases to ease the transition to the new names.

Breaking

  • The assignTeams and assignUsers config options in the harmony.json configuration file were renamed to requestTeams and requestUsers. Although the old names will continue to work via the harmony config ... CLI command, only the new names will be stored in the harmony.json file. This makes the configuration file not backwards compatible with older versions of Harmony. Harmony will automatically update the config file for you.

Install via npm with npm install --global @mattpolzin/harmony or by downloading the attached harmony-npm.tar.gz file, extracting, and then running npm install -g from the unzipped folder to install globally on your system. Use in a nix shell (assuming flakes are enabled) with nix shell github:mattpolzin/harmony.

You can build the source with Idris 2 v0.7.0 or the latest HEAD of the main Idris 2 branch.

Assets 3
Loading