-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initial introduction of a opam-release tool
This is a tool to generate a branch (and a pull-request manually) from the opam meta data local to the repository. Most of the arguments are inferred automatically if one: - has a unique file named <your-project>.opam - is using a github repository - has their github username configured in their global .gitconfig - has performed git remote update - the dev-repo is set in the opam file - opam is installed Arguments can be supplied to fix any of the default behavior (or their absence thereof). One can witness the inferred arguments by providing option `-s`
- Loading branch information
1 parent
6d0eada
commit 3f88956
Showing
1 changed file
with
259 additions
and
0 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,259 @@ | ||
| #!/usr/bin/env bash | ||
| set -e | ||
|
|
||
| if [ "$DEBUG" = 1 ]; then | ||
| set -x | ||
| fi | ||
|
|
||
| show_help(){ | ||
| cat <<EOF | ||
| Usage : opam-release (arguments)* (opam-files)* | ||
| -- | ||
| Optional arguments: | ||
| opam-files: one or many opam files to push to opam-coq-archive | ||
| *if no argument is provided, it lists *.opam files in the current directory | ||
| -u GITHUBUSER / --user GITHUBUSER: | ||
| where GITHUBUSER is your github username, | ||
| you must have a fork of coq/opam-coq-archive under | ||
| https://github.com/$GITHUBUSER/opam-coq-archive | ||
| for this command to work, | ||
| * if not provided, tries "git config --get github.user" | ||
| -p PROJECT / --project PROJECT: | ||
| where PROJECT is a name of the project, | ||
| without space, it is used solely for generating | ||
| the name of the branch and PR, | ||
| * automatically infered from the name of the opam file | ||
| if only one was given, | ||
| -e DEPTH / --depth DEPTH: | ||
| sets the depth of the local clone of opam-coq-archive to $DEPTH | ||
| * defaults to full clone, | ||
| you may want to fix the DEPTH to save bandwidth and time | ||
| -V VERSION / --version VERSION: | ||
| where VERSION is the opam version number of | ||
| the package to create, | ||
| * if no version is provided, tries to find the latest tag, | ||
| you may want to perform a "git remote update" to fetch all tags first | ||
| -U URL / --url URL: | ||
| where URL is the url of the archive associated | ||
| with the version to release. | ||
| * tries to infer it from the "dev-repo" section if one opam file is provided | ||
| -x PREFIX / --version-prefix PREFIX: the tag of a version is equal to $PREFIX$VERSION | ||
| * default is "" | ||
| ** this options is used only if URL is not provided | ||
| -d / --dev: pushes an update to extra-dev instead of releases | ||
| -C / --no-check-upstream: tells opam lint not to check the sum online | ||
| -h / -? / --help: print this usage | ||
| -s / --show-defaults: prints the default inferred setting and exists | ||
| -v / --verbose: show debug information | ||
| -L / --no-lint: do not run opam lint | ||
| (not recommended but useful if you do not have opam installed) | ||
| -n / --do-nothing: do not push anything | ||
| EOF | ||
| } | ||
|
|
||
| die() { | ||
| printf '%s\n' "$1" >&2 | ||
| exit 1 | ||
| } | ||
|
|
||
| GITHUBUSER=$(git config --get github.user) | ||
| VERSION=$(git describe --tags --abbrev=0 | sed -e "s/[^0-9]*\(\([0-9]+|\.\)\)*/\1/") | ||
| PROJECT= | ||
| URL= | ||
| LINT=1 | ||
| NOTHING=0 | ||
| DEPTH= | ||
| HDEPTH= | ||
| TARGET="released" | ||
| OPAM=() | ||
| CHECKUPSTREAM="--check-upstream" | ||
| VERSIONPREFIX= | ||
| SHOWDEFAULTS=0 | ||
|
|
||
| while :; do | ||
| case $1 in | ||
| -h|-\?|--help) | ||
| show_help # Display a usage synopsis. | ||
| exit 0 | ||
| ;; | ||
| -u|--user) | ||
| if [ "$2" ]; then GITHUBUSER=$2; shift; shift | ||
| else die 'ERROR: "--user" requires a non-empty argument, cf --help' | ||
| fi | ||
| ;; | ||
| -p|--project) | ||
| if [ "$2" ]; then PROJECT=$2; shift; shift | ||
| else die 'ERROR: "--name" requires a non-empty argument, cf --help' | ||
| fi | ||
| ;; | ||
| -V|--version) | ||
| if [ "$2" ]; then VERSION=$2; shift; shift | ||
| else die 'ERROR: "--name" requires a non-empty argument, cf --help' | ||
| fi | ||
| ;; | ||
| -U|--url) | ||
| if [ "$2" ]; then URL=$2; shift; shift | ||
| else die 'ERROR: "--name" requires a non-empty argument, cf --help' | ||
| fi | ||
| ;; | ||
| -e|--depth) | ||
| if [ "$2" ]; then HDEPTH="$2"; DEPTH="--depth=$2"; shift; shift | ||
| else die 'ERROR: "--name" requires a non-empty argument, cf --help' | ||
| fi | ||
| ;; | ||
| -x|--version-prefix) | ||
| if [ "$2" ]; then VERSIONPREFIX=$2; shift; shift | ||
| else die 'ERROR: "--name" requires a non-empty argument, cf --help' | ||
| fi | ||
| ;; | ||
| -L|--no-lint) | ||
| LINT=0; shift | ||
| ;; | ||
| -d|--dev) | ||
| TARGET="extra-dev" | ||
| VERSION="dev" | ||
| CHECKUPSTREAM= | ||
| shift | ||
| ;; | ||
| -C|--no-check-upstream) | ||
| CHECKUPSTREAM= | ||
| shift | ||
| ;; | ||
| -v|--verbose) | ||
| VERBOSE=1; shift | ||
| ;; | ||
| -s|--show-defaults) | ||
| SHOWDEFAULTS=1; shift | ||
| ;; | ||
| -n|--do-nothing) | ||
| NOTHING=1; shift | ||
| ;; | ||
| *) # unknown option | ||
| if ! [ "$*" ]; then | ||
| break | ||
| elif [ -f "$1" ]; then | ||
| OPAM+=("$1") | ||
| shift | ||
| else die 'ERROR: positional arguments must be a file' | ||
| fi | ||
| ;; | ||
| esac | ||
| done | ||
|
|
||
| if ! [ "$OPAM" ]; then | ||
| OPAM=(); for opam in *.opam; do OPAM+=("$opam"); done | ||
| fi | ||
|
|
||
| eval set -- "${OPAM[@]}" | ||
|
|
||
| if ! [ "GITHUBUSER" ]; then | ||
| die 'ERROR: -u / --user argument is required, cf --help' | ||
| fi | ||
|
|
||
| if ! [ "VERSION" ]; then | ||
| die 'ERROR: -V / --version argument is required, cf --help' | ||
| fi | ||
|
|
||
|
|
||
| case "${#OPAM[@]}" in | ||
| 0) | ||
| die 'ERROR: no opam file provided or found cf --help' | ||
| ;; | ||
| 1) | ||
| if ! [ "$PROJECT" ]; then | ||
| PROJECT=$(basename "${OPAM[0]}" .opam) | ||
| fi | ||
| ;; | ||
| *) | ||
| if ! [ "$PROJECT" ]; then | ||
| die 'ERROR: -p / --project argument is required when more than one opam files are given, cf --help' | ||
| fi | ||
| ;; | ||
| esac | ||
|
|
||
| if ! [ "$URL" ]; then | ||
| if [ "$TARGET" = "released" ]; then | ||
| URL=$(opam show -f dev-repo --file "${OPAM[0]}" | sed -e "s/git+//" | sed -e "s+\.git+/archive/${VERSIONPREFIX}${VERSION}.tar.gz+") | ||
| else | ||
| URL="$(opam show -f dev-repo --file ${OPAM[0]})#master" | ||
| fi | ||
| fi | ||
|
|
||
| if [ "$VERBOSE" = 1 ] || [ "$SHOWDEFAULTS" = 1 ]; then | ||
| echo "# this would call" | ||
| echo "$0 \\" | ||
| if [ "$VERBOSE" = 1 ]; then echo "-v \\"; fi | ||
| echo "-u $GITHUBUSER \\" | ||
| echo "-V $VERSION \\" | ||
| echo "-p $PROJECT \\" | ||
| echo "-U $URL \\" | ||
| if [ "$LINT" = 0 ]; then echo "-L \\"; fi | ||
| if [ "$NOTHING" = 1 ]; then echo "-n \\"; fi | ||
| if [ "$HDEPTH" ]; then echo "-e $HDEPTH \\"; fi | ||
| if [ "$TARGET" = "extra-dev" ]; then echo "--dev \\"; fi | ||
| if ! [ "$CHECKUPSTREAM" ]; then echo "-C \\"; fi | ||
| echo "${OPAM[@]}" | ||
|
|
||
| fi | ||
|
|
||
| if [ "$SHOWDEFAULTS" = 1 ]; then | ||
| exit | ||
| fi | ||
|
|
||
| COA=$(mktemp -d) # stands for Coq Opam Archive | ||
| git clone $DEPTH [email protected]:coq/opam-coq-archive $COA -o upstream | ||
| git -C $COA remote add origin [email protected]:$GITHUBUSER/opam-coq-archive | ||
| BRANCH=$PROJECT.$VERSION | ||
| git -C $COA checkout -b $BRANCH | ||
| PKGS=$COA/$TARGET/packages | ||
|
|
||
| ARCHIVE=$(mktemp) | ||
| if [ "$TARGET" = "released" ]; then | ||
| curl -L $URL -o $ARCHIVE | ||
| SUM=$(sha256sum $ARCHIVE | cut -d " " -f 1) | ||
| fi | ||
|
|
||
| if [ "$VERBOSE" = 1 ]; then | ||
| echo "COA=$COA" | ||
| echo "BRANCH=$BRANCH" | ||
| echo "PKGS=$PKGS" | ||
| echo "ARCHIVE=$ARCHIVE" | ||
| echo "SUM=$SUM" | ||
| fi | ||
|
|
||
| for opam in ${OPAM[@]}; do | ||
| B=$(basename $opam .opam) | ||
| P=$PKGS/$B/$B.$VERSION | ||
| mkdir -p $P | ||
| sed "/^version:.*/d" $opam > $P/opam | ||
| sed -i -e '/^[ \t]*#/d' $P/opam | ||
| echo "" >> $P/opam | ||
| echo "url {" >> $P/opam | ||
| echo " src: \"$URL\"" >> $P/opam | ||
| if [ "$TARGET" = "released" ]; then | ||
| echo " checksum: \"sha256=$SUM\"" >> $P/opam | ||
| fi | ||
| echo "}" >> $P/opam | ||
| if [ "$LINT" = 1 ]; then | ||
| opam lint $CHECKUPSTREAM $P/opam | ||
| else | ||
| echo "linting disabled (not recommended)" | ||
| fi | ||
| git -C $COA add $P/opam | ||
| done | ||
|
|
||
| if [ "$NOTHING" = 1 ]; then | ||
| echo "Dry running!" | ||
| echo git -C $COA commit -m "Release $PROJECT $VERSION" | ||
| echo git -C $COA push origin -f $BRANCH | ||
| else | ||
| git -C $COA commit -m "Update $PROJECT $VERSION" | ||
| git -C $COA push origin -f $BRANCH | ||
| echo "**********************************************************************" | ||
| echo "Create a pull request by visiting" | ||
| echo "https://github.com/$GITHUBUSER/opam-coq-archive/pull/new/$BRANCH" | ||
| echo "**** PLEASE CHECK CAREFULLY THE GENERATED CODE ***" | ||
| echo "If you wish to delete the resulting branch, execute:" | ||
| echo "git -C $COA push origin --delete $BRANCH" | ||
| echo "**********************************************************************" | ||
| fi |