-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ci: Add cocogitto/release.sh to perform releases. (#206)
Fixes #213 Fixes #218 * Add cog.toml to configure cocogitto, which generates changelogs and version tags * Add tools/release.sh to perform a complete version bump + changelog update and github release for a plugin * Updated README.md with instructions regarding the release process --------- Co-authored-by: Mike Bender <[email protected]>
- Loading branch information
1 parent
79a1002
commit 63945e7
Showing
7 changed files
with
475 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| from_latest_tag = true | ||
| ignore_merge_commits = false | ||
| disable_changelog = false | ||
| # we never tag any code outside the plugins/ directory. Everything else is build glue. | ||
| generate_mono_repository_global_tag = false | ||
| # limit which branches to perform bumps from | ||
| branch_whitelist = [ "main" ] | ||
| # we don't really use [skip ci] action filtering, but leaving here in case we decide to someday | ||
| skip_ci = "[skip ci]" | ||
| skip_untracked = false | ||
| tag_prefix = "v" | ||
|
|
||
| # bump hooks for global versions only; we don't use global version, but leaving here for posterity | ||
| pre_bump_hooks = [] | ||
| post_bump_hooks = [] | ||
|
|
||
| # bump hooks for package versions, which is what we actually use | ||
| pre_package_bump_hooks = [ | ||
| "echo Updating {{package}} to version {{version}}", | ||
| # make sure user has correct software installed and is authenticated with `gh` cli tool | ||
| "../../tools/validate.sh", | ||
| # change the version number of the given plugin in source, and commit it as a chore(version): commit | ||
| "../../tools/update_version.sh {{package}} {{version}} -d", | ||
| ] | ||
| # between pre_ and post_ bump hooks, cog itself will update the checked in CHANGELOG.md file, per updated plugin. | ||
| post_package_bump_hooks = [ | ||
| # prepare the github release changelog file | ||
| "mkdir -p ../../releases", | ||
| "../../tools/extract_changelog.sh CHANGELOG.md > ../../releases/GITHUB_CHANGELOG-{{package}}.md", | ||
| # update the version number to have a .dev0 suffix (when possible, only done for python plugins) | ||
| "../../tools/update_version.sh {{package}} {{version}} --dev", | ||
| "git commit -m 'chore(version): update {{package}} version to {{version}}'", | ||
| # push the tag and the commits to main | ||
| "git push origin {{package}}-v{{version}}", | ||
| "git push origin main", | ||
| # cut a github release using our conventional-commit changelog | ||
| "gh release create {{package}}-v{{version}} --notes-file ../../releases/GITHUB_CHANGELOG-{{package}}.md --title {{package}}-v{{version}} --verify-tag" | ||
| ] | ||
|
|
||
| [git_hooks] | ||
|
|
||
| [commit_types] | ||
| # exclude chore and ci commits from changelog entries | ||
| chore = { changelog_title = "", omit_from_changelog = true } | ||
| ci = { changelog_title = "", omit_from_changelog = true } | ||
|
|
||
| [changelog] | ||
| path = "CHANGELOG.md" | ||
| template = "remote" | ||
| remote = "github.com" | ||
| repository = "deephaven-plugins" | ||
| owner = "deephaven" | ||
| authors = [ | ||
| { username = "jnumainville", signature = "Joe Numainville" }, | ||
| { username = "mofojed", signature = "Mike Bender" }, | ||
| { username = "devinrsmith", signature = "Devin Smith" }, | ||
| { username = "mattrunyon", signature = "Matt Runyon" }, | ||
| { username = "vbabich", signature = "Vlad Babich" }, | ||
| { username = "dsmmcken", signature = "Don McKenzie" }, | ||
| { username = "bmingles", signature = "Brian Ingles" }, | ||
| { username = "niloc132", signature = "Colin Alworth" }, | ||
| { username = "rachelmbrubaker", signature = "Rachel Brubaker" }, | ||
| { username = "JamesXNelson", signature = "James Nelson" }, | ||
|
|
||
| ] | ||
|
|
||
| [bump_profiles] | ||
|
|
||
|
|
||
| [packages] | ||
| auth-keyclock = { path = "plugins/auth-keyclock", public_api=false } | ||
| dashboard-object-viewer = { path = "plugins/dashboard-object-viewer", public_api=false } | ||
| json = { path = "plugins/json", public_api=false } | ||
| matplotlib = { path = "plugins/matplotlib", public_api=false } | ||
| plotly = { path = "plugins/plotly", public_api=false } | ||
| plotly-express = { path = "plugins/plotly-express", public_api=false } | ||
| table-example = { path = "plugins/table-example", public_api=false } | ||
| ui = { path = "plugins/ui", public_api=false } | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| #!/bin/bash | ||
|
|
||
| # This workaround is borrowed from https://github.com/cocogitto/cocogitto/issues/300 | ||
| # It extracts the top chunk of an individual plugin's changelog into the github release changelog file. | ||
|
|
||
| if [ ! -f "$1" ]; then | ||
| echo "The file passed as first argument, $1, does not exist." | ||
| exit 1 | ||
| fi | ||
|
|
||
| separator_count=0 | ||
| extract_data=false | ||
|
|
||
| while IFS= read -r line; do | ||
| if $extract_data && [[ "$line" != "- - -" ]]; then | ||
| echo "$line" | ||
| fi | ||
|
|
||
| if [[ "$line" == "- - -" ]]; then | ||
| ((separator_count++)) | ||
| if ((separator_count == 1)); then | ||
| extract_data=true | ||
| elif ((separator_count == 2)); then | ||
| break | ||
| fi | ||
| fi | ||
| done < "$1" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| #!/bin/bash | ||
|
|
||
| # This script is designed to automate the version bump + github release process. | ||
| # It requires for you to have installed both the [GitHub CLI tool](https://cli.github.com/) `gh` and the [cocogitto tool](https://github.com/cocogitto/cocogitto#installation) `cog` | ||
|
|
||
| tab=$'\t' | ||
| log_prefix="$(id -un)$tab - " | ||
|
|
||
| set -o errexit | ||
| set -o nounset | ||
| set -o pipefail | ||
|
|
||
| SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )" | ||
| ROOT_DIR="$(dirname "$SCRIPT_DIR")" | ||
| SCRIPT_NAME=$(basename "${BASH_SOURCE[0]}") | ||
|
|
||
| function log_error() { | ||
| { echo -e "\033[31m$log_prefix $(date "+%Y-%m-%d %H:%M:%S")$tab |--- [ERROR] $* \033[0m" ; } 2> /dev/null | ||
| } 2>/dev/null | ||
|
|
||
| function log_info() { | ||
| { echo "$log_prefix $(date "+%Y-%m-%d %H:%M:%S")$tab |--- $*" ; } 2>/dev/null | ||
| } 2>/dev/null | ||
|
|
||
| if ! which cog >/dev/null; then | ||
| { | ||
| log_error "cog command not found!" | ||
| log_error "Installation instructions are here: https://github.com/cocogitto/cocogitto?tab=readme-ov-file#installation" | ||
| log_error "mac users can install via brew; for other OSes, you should install cargo and then use cargo to install cocogitto (cog)" | ||
| log_error "Note that cog must be on your PATH. An alias will not work." | ||
| } 2>/dev/null | ||
| exit 99 | ||
| fi | ||
|
|
||
| # todo: enforce git remote named origin | ||
|
|
||
| all_plugins="$(cd "$ROOT_DIR/plugins" ; find . -mindepth 1 -maxdepth 1 -type d | sed 's|./||g')" | ||
|
|
||
| function usage() { | ||
| log_info "Simple utility to automate version bump + release process" | ||
| log_info "This script accepts the following arguments:" | ||
| log_info "" | ||
| log_info "--help | -h $tab-> Prints this help message" | ||
| log_info "--debug | -d $tab-> Turn on xtrace debugging" | ||
| log_info "<plugin name> $tab-> Runs the version bump + release for a given plugin" | ||
| log_info "Valid <plugin name> choices are: | ||
| $all_plugins" | ||
| } 2> /dev/null | ||
|
|
||
| if [ -n "$(git status --short)" ]; then | ||
| { | ||
| log_error "Detected uncommitted files via git status:" | ||
| git status --short | ||
| log_error "Releases can only be performed with a clean git status" | ||
| log_error 'You must commit/stash your changes, or `git reset --hard` to erase them' | ||
| exit 95 | ||
| } 2>/dev/null | ||
| fi | ||
|
|
||
| # Collect arguments | ||
| package= | ||
| while (( $# > 0 )); do | ||
| case "$1" in | ||
| --debug | -d) | ||
| set -o xtrace ;; | ||
| --help | -h) | ||
| usage ; exit 0 ;; | ||
| *) | ||
| if [ -n "$package" ]; then | ||
| { | ||
| log_error "Illegal argument $1. Already requested release of package '$package'" | ||
| log_error "You can only release one package at a time" | ||
| } 2>/dev/null | ||
| exit 94 | ||
| fi | ||
| if grep -qE "^$1\$" <<< "$all_plugins"; then | ||
| package="$1" | ||
| else | ||
| { | ||
| log_error "Illegal argument $1. Expected one of: | ||
| $all_plugins" | ||
| } 2>/dev/null | ||
| exit 93 | ||
| fi | ||
| ;; | ||
| esac | ||
| shift | ||
| done | ||
|
|
||
| # Validate arguments | ||
| if [ -z "$package" ]; then | ||
| { | ||
| log_error "Expected exactly one package name argument" | ||
| log_error "Valid choices are: | ||
| $all_plugins" | ||
| } 2>/dev/null | ||
| exit 92 | ||
| fi | ||
|
|
||
| if ! grep -q "plugins/$package" "$ROOT_DIR/cog.toml"; then | ||
| { | ||
| log_error "Did not see plugins/$package in cog.toml" | ||
| log_error "Make sure to list your plugins under the [plugins] section of cog.toml" | ||
| } 2>/dev/null | ||
| exit 91 | ||
| fi | ||
|
|
||
| if [ -n "$(git status --short)" ]; then | ||
| { | ||
| log_error "Detected uncommitted files via git status:" | ||
| git status --short | ||
| log_error "Releases can only be performed with a clean git status" | ||
| log_error 'You must commit/stash your changes, or `git reset --hard` to erase them' | ||
| exit 95 | ||
| } 2>/dev/null | ||
| fi | ||
|
|
||
| # Perform release | ||
| { log_info "Releasing package '$package'" ; } 2>/dev/null | ||
| ( | ||
| cd "$ROOT_DIR" | ||
| cog bump --package "$package" --auto | ||
| ) |
Oops, something went wrong.