commit 7201effd296741732e0a9e0ad8e0fce82be06e9f Author: Swordsteel Date: Thu Oct 17 12:53:14 2024 +0100 Set up project structure diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..53fbc87 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,16 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +indent_size = 4 +indent_style = space +insert_final_newline = true +max_line_length = 120 +tab_width = 4 + +[*.toml] +max_line_length = 1024 + +[*.{bat,cmd}] +end_of_line = crlf diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..53fd7b4 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar + +### IntelliJ IDEA ### +.idea/ diff --git a/README.md b/README.md new file mode 100644 index 0000000..f8b7bef --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# Hlæja Version Catalog. + +A Version Catalog in Gradle is a centralized way to manage and reference dependency versions across multiple projects, reducing duplication and ensuring consistency in dependency management. It simplifies the process of updating dependencies by maintaining a single source of truth for versions. + +## Releasing version catalog. + +Run `release.sh` script from `master` branch. + +## Publishing version catalog. + +### Publish version catalog locally. + +```shell +./gradlew clean publishToMavenLocal +``` + +### Publish version catalog to repository. + +```shell +./gradlew clean publish +``` + +### Global gradle properties. + +To authenticate with Gradle to access repositories that require authentication, you can set your user and token in the `gradle.properties` file. + +Here's how you can do it: + +1. Open or create the `gradle.properties` file in your Gradle user home directory: + - On Unix-like systems (Linux, macOS), this directory is typically `~/.gradle/`. + - On Windows, this directory is typically `C:\Users\\.gradle\`. +2. Add the following lines to the `gradle.properties` file: + ```properties + repository.user=your_user + repository.token=your_token_value + ``` + or use environment variables `REPOSITORY_USER` and `REPOSITORY_TOKEN` diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..6e0e007 --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,50 @@ +import java.lang.System.getenv + +plugins { + `version-catalog` + `maven-publish` +} + +description = "Hlæja Version Catalog" +group = "ltd.hlaeja.catalog" + +catalog { + versionCatalog { + from(files("hlaeja.versions.toml")) + } +} + +publishing { + repositories { + + fun retrieveConfiguration( + property: String, + environment: String, + ): String? = project.findProperty(property)?.toString() ?: getenv(environment) + + maven { + url = uri("https://maven.pkg.github.com/swordsteel/${project.name}") + name = "GitHubPackages" + credentials { + username = retrieveConfiguration("repository.user", "REPOSITORY_USER") + password = retrieveConfiguration("repository.token", "REPOSITORY_TOKEN") + } + } + } + publications { + create(project.name) { + groupId = "$group" + artifactId = project.name + version = version + from(components["versionCatalog"]) + } + } +} + +tasks.register("clean") { + group = "build" + doLast { + delete("${rootDir.path}/build") + println("Default Cleaning!") + } +} diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..1704855 --- /dev/null +++ b/gradle.properties @@ -0,0 +1 @@ +version=0.1.0-SNAPSHOT diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..249e583 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..f514e80 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Thu Oct 17 08:20:06 BST 2024 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..1b6c787 --- /dev/null +++ b/gradlew @@ -0,0 +1,234 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/hlaeja.versions.toml b/hlaeja.versions.toml new file mode 100644 index 0000000..30ad3ab --- /dev/null +++ b/hlaeja.versions.toml @@ -0,0 +1,5 @@ +[versions] + +[libraries] + +[plugins] diff --git a/release.sh b/release.sh new file mode 100755 index 0000000..52a2af6 --- /dev/null +++ b/release.sh @@ -0,0 +1,94 @@ +#!/bin/sh + +### This should be a pipeline, but for this example let use this ### + +check_active_branch() { + if [ "$(git rev-parse --abbrev-ref HEAD)" != "$1" ]; then + echo "Error: The current branch is not $1." + exit 1 + fi +} + +check_uncommitted_changes() { + if [ -n "$(git status --porcelain)" ]; then + echo "Error: There are uncommitted changes in the repository." + exit 1 + fi +} + +prepare_environment() { + git fetch origin +} + +check_last_commit() { + last_commit_message=$(git log -1 --pretty=format:%s) + if [ "$last_commit_message" = "[RELEASE] - bump version" ]; then + echo "Warning: Nothing to release!!!" + exit 1 + fi +} + +check_differences() { + if ! git diff --quiet origin/"$1" "$1"; then + echo "Error: The branches origin/$1 and $1 have differences." + exit 1 + fi +} + +un_snapshot_catalog() { + sed -i "s/^\($1\s*=\s*\"[0-9.]*\)-SNAPSHOT.*$/\1\"/" hlaeja.versions.toml +} + +un_snapshot_version() { + sed -i "s/\($1\s*=\s*[0-9]\+\.[0-9]\+\.[0-9]\+\).*/\1/" gradle.properties +} + +current_version() { + awk -F '=' '/version\s*=\s*[0-9.]*/ {gsub(/^ +| +$/,"",$2); print $2}' gradle.properties +} + +stage_files() { + for file in "$@"; do + if git diff --exit-code --quiet -- "$file"; then + echo "No changes in $file" + else + git add "$file" + echo "Changes in $file staged for commit" + fi + done +} + +commit_change() { + stage_files gradle.properties hlaeja.versions.toml + git commit -m "[RELEASE] - $1" + git push --porcelain origin master +} + +add_release_tag() { + gitTag="v$(current_version)" + git tag -a "$gitTag" -m "Release version $gitTag" + git push --porcelain origin "$gitTag" +} + +snapshot_version() { + new_version="$(current_version | awk -F '.' '{print $1 "." $2+1 ".0"}')" + sed -i "s/\(version\s*=\s*\)[0-9.]*/\1$new_version-SNAPSHOT/" gradle.properties +} + +# check and prepare for release +check_active_branch master +check_uncommitted_changes +prepare_environment +check_last_commit +check_differences master + +# un-snapshot catalog versions for release + +# un-snapshot properties for release +un_snapshot_version version + +# release changes and prepare for next release +commit_change "release version: $(current_version)" +add_release_tag +snapshot_version +commit_change 'bump version' diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..1f2c23f --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1 @@ +rootProject.name = "hlaeja-version-catalog"