-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add helper script for creating GitHub releases using gh
Problem: Some of our projects have a job in the CI pipeline that creates GitHub release with some release artifacts. We'd like to unify the approach for creating such releases. Solution: Add autorelease script to 'lib.github.autorelease'.
- Loading branch information
Showing
3 changed files
with
56 additions
and
2 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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 |
---|---|---|
|
@@ -126,4 +126,6 @@ in | |
''; | ||
}; | ||
}; | ||
|
||
github = import ./github.nix { inherit (final) gh git writeShellApplication; }; | ||
} |
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,52 @@ | ||
{ gh, git, writeShellApplication }: | ||
{ | ||
# autorelease <release-assets> <release-notes> [release-tag] | ||
# | ||
# release-assets | ||
# A path to the directory with release assets, typically something like "$(nix build .#release)" | ||
# release-notes | ||
# Either a path to the file or bare text to use as release notes. | ||
# release-tag (optional) | ||
# A tag for the release to be pushed and also to be used as a release title. | ||
# Default value to be used is 'auto-release'. | ||
# | ||
# If 'release-tag' is 'autorelease' or 'PRERELEASE' env variable is set to 'true' | ||
# created release is marked as 'prerelease'. | ||
# | ||
# 'OVERWRITE_RELEASE' env variable is set to 'true' an existing release with 'release-tag' | ||
# will be deleted prior to recreation. | ||
# | ||
# This script expects 'GH_TOKEN' env variable to be set to a GitHub PAT that is capable of | ||
# managing releases in the target repository. | ||
# | ||
# Usage examples: | ||
# autorelease "$(nix build .#release)" "Automatic release on "$(date +\"%Y%m%d%H%M\")"" | ||
# | ||
# autorelease "$(nix build .#release)" ./release-notes.md "v1.0" | ||
autorelease = writeShellApplication { | ||
name = "autorelease"; | ||
runtimeInputs = [ gh git ]; | ||
text = '' | ||
release_assets="$1" | ||
release_notes="$2"; | ||
release_tag="''${3:-auto-release}" | ||
if [[ ''${OVERWRITE_RELEASE:-false} == true ]]; then | ||
# Delete release if it exists | ||
gh release delete "$release_tag" --yes || true | ||
fi | ||
typeset -a release_args | ||
# Create release | ||
if [[ $release_tag == "auto-release" || ''${PRERELEASE:-false} == true ]]; then | ||
release_args+=("--prerelease") | ||
fi | ||
if [[ -f $release_notes ]]; then | ||
release_args+=("--notes-file" "$release_notes") | ||
else | ||
release_args+=("--notes" "$release_notes") | ||
fi | ||
gh release create "$release_tag" --target "$(git rev-parse HEAD)" --title "$release_tag" "''${release_args[@]}" "$release_assets"/* | ||
''; | ||
}; | ||
} |