Refactor jjpush workflow and enhance release notes generation

Split the jjpush target into multiple sub-targets (jjpush-describe, jjpush-bump, jjpush-push, jjpush-tag) for better modularity and control. Enhance release notes generation by: - Using git log with full commit messages instead of GitHub API for pre-release mode - Adding robust JSON parsing with fallbacks for release notes - Including detailed installation instructions in release notes - Supporting both pre-release and published release modes Update release_notes.sh to handle pre-release mode, improve commit message fetching, and add installation section to release notes. Add .PHONY declarations for new sub-targets.
2026-03-25 13:30:52 +00:00 · 2026-02-20 11:52:34 +01:00
parent 1ba1294b11
commit 61e346658e
2 changed files with 175 additions and 62 deletions
--- a/release_notes.sh
+++ b/release_notes.sh
@@ -21,6 +21,74 @@ LLM_MODEL="ollama:qwen3-coder-next:latest"

 die() { echo "Error: $*" >&2; exit 1; }

+next_patch() {
+  local v="$1"
+  local major minor patch
+  major=$(echo "$v" | cut -d. -f1)
+  minor=$(echo "$v" | cut -d. -f2)
+  patch=$(echo "$v" | cut -d. -f3)
+  echo "${major}.${minor}.$(( patch + 1 ))"
+}
+
+# Strip "pre-" prefix to get the bare version number for installation section
+bare_version() {
+  echo "$1" | sed 's/^pre-//'
+}
+
+installation_section() {
+  local v
+  v=$(bare_version "$1")
+  cat <<INSTALL_EOF
+
+## Installation
+
+### Pre-built binaries
+
+Download the appropriate archive for your system from the
+[release assets](https://github.com/metabarcoding/obitools4/releases/tag/Release_${v})
+and extract it:
+
+#### Linux (AMD64)
+\`\`\`bash
+tar -xzf obitools4_${v}_linux_amd64.tar.gz
+\`\`\`
+
+#### Linux (ARM64)
+\`\`\`bash
+tar -xzf obitools4_${v}_linux_arm64.tar.gz
+\`\`\`
+
+#### macOS (Intel)
+\`\`\`bash
+tar -xzf obitools4_${v}_darwin_amd64.tar.gz
+\`\`\`
+
+#### macOS (Apple Silicon)
+\`\`\`bash
+tar -xzf obitools4_${v}_darwin_arm64.tar.gz
+\`\`\`
+
+All OBITools4 binaries are included in each archive.
+
+### From source
+
+You can also compile and install OBITools4 directly from source using the
+installation script:
+
+\`\`\`bash
+curl -L https://raw.githubusercontent.com/metabarcoding/obitools4/master/install_obitools.sh | bash -s -- --version ${v}
+\`\`\`
+
+By default binaries are installed in \`/usr/local/bin\`. Use \`--install-dir\` to
+change the destination and \`--obitools-prefix\` to add a prefix to command names:
+
+\`\`\`bash
+curl -L https://raw.githubusercontent.com/metabarcoding/obitools4/master/install_obitools.sh | \\
+  bash -s -- --version ${v} --install-dir ~/local --obitools-prefix k
+\`\`\`
+INSTALL_EOF
+}
+
 display_help() {
  cat <<EOF
 Usage: $(basename "$0") [OPTIONS]
@@ -81,49 +149,74 @@ all_versions=$(fetch_versions)
 [ -z "$all_versions" ] && die "Could not fetch versions from GitHub"

 if [ -z "$VERSION" ]; then
-  VERSION=$(echo "$all_versions" | head -1)
-  echo "Using latest version: $VERSION" >&2
-fi
+   # ── Pre-release mode: local HEAD vs latest GitHub tag ──────────────────
+   PRE_RELEASE=true
+   previous_tag="Release_${latest_version}"
+   VERSION="pre-$(next_patch "$latest_version")"

-tag_name="Release_${VERSION}"
+   echo "Pre-release mode: $previous_tag -> HEAD (as $VERSION)" >&2

-# Verify the requested version exists
-if ! echo "$all_versions" | grep -qx "$VERSION"; then
-  die "Version $VERSION not found. Use -l to list available versions."
-fi
+   # Need to be in a git repo
+   if ! git rev-parse --is-inside-work-tree >/dev/null 2>&1; then
+     die "Not inside a git repository. Pre-release mode requires a local git repo."
+   fi

-# Find the previous version (the one right after in the sorted-descending list)
-previous_version=$(echo "$all_versions" | grep -A1 -x "$VERSION" | tail -1)
+   # Check that the previous tag exists locally
+   if ! git rev-parse "$previous_tag" >/dev/null 2>&1; then
+     echo "Tag $previous_tag not found locally, fetching..." >&2
+     git fetch --tags 2>/dev/null || true
+     if ! git rev-parse "$previous_tag" >/dev/null 2>&1; then
+       die "Tag $previous_tag not found locally or remotely"
+     fi
+   fi

-if [ "$previous_version" = "$VERSION" ] || [ -z "$previous_version" ]; then
-  previous_tag=""
-  echo "No previous version found -- will include all commits for $tag_name" >&2
-else
-  previous_tag="Release_${previous_version}"
-  echo "Generating notes: $previous_tag -> $tag_name" >&2
-fi
+  # Get local commits from the tag to HEAD (full messages)
+  commit_list=$(git log --format="%h %B" "${previous_tag}..HEAD" 2>/dev/null)

-# ── Fetch commit messages between tags via GitHub compare API ────────────
+   if [ -z "$commit_list" ]; then
+     die "No local commits found since $previous_tag"
+   fi
+ else
+   # ── Published release mode: between two GitHub tags ────────────────────
+   PRE_RELEASE=false
+   tag_name="Release_${VERSION}"

-if [ -n "$previous_tag" ]; then
-  commits_json=$(curl -sf "${GITHUB_API}/compare/${previous_tag}...${tag_name}")
-  if [ -z "$commits_json" ]; then
-    die "Could not fetch commit comparison from GitHub"
-  fi
-  commit_list=$(echo "$commits_json" \
-    | jq -r '.commits[] | (.sha[:8] + " " + (.commit.message | split("\n")[0]))' 2>/dev/null)
-else
-  # First release: get commits up to this tag
-  commits_json=$(curl -sf "${GITHUB_API}/commits?sha=${tag_name}&per_page=50")
-  if [ -z "$commits_json" ]; then
-    die "Could not fetch commits from GitHub"
-  fi
-  commit_list=$(echo "$commits_json" \
-    | jq -r '.[] | (.sha[:8] + " " + (.commit.message | split("\n")[0]))' 2>/dev/null)
-fi
+   # Verify the requested version exists
+   if ! echo "$all_versions" | grep -qx "$VERSION"; then
+     die "Version $VERSION not found. Use -l to list available versions."
+   fi

-if [ -z "$commit_list" ]; then
-  die "No commits found between $previous_tag and $tag_name"
+   # Find the previous version
+   previous_version=$(echo "$all_versions" | grep -A1 -x "$VERSION" | tail -1)
+
+   if [ "$previous_version" = "$VERSION" ] || [ -z "$previous_version" ]; then
+     previous_tag=""
+     echo "No previous version found -- will include all commits for $tag_name" >&2
+   else
+     previous_tag="Release_${previous_version}"
+     echo "Generating notes: $previous_tag -> $tag_name" >&2
+   fi
+
+   # Fetch commit messages between tags via GitHub compare API
+   if [ -n "$previous_tag" ]; then
+     commits_json=$(curl -sf "${GITHUB_API}/compare/${previous_tag}...${tag_name}")
+     if [ -z "$commits_json" ]; then
+       die "Could not fetch commit comparison from GitHub"
+     fi
+     commit_list=$(echo "$commits_json" \
+      | jq -r '.commits[] | (.sha[:8] + " " + .commit.message)' 2>/dev/null)
+   else
+     commits_json=$(curl -sf "${GITHUB_API}/commits?sha=${tag_name}&per_page=50")
+     if [ -z "$commits_json" ]; then
+       die "Could not fetch commits from GitHub"
+     fi
+     commit_list=$(echo "$commits_json" \
+      | jq -r '.[] | (.sha[:8] + " " + .commit.message)' 2>/dev/null)
+   fi
+
+   if [ -z "$commit_list" ]; then
+     die "No commits found between $previous_tag and $tag_name"
+   fi
 fi

 # ── LLM prompt (shared by context mode and summarization) ────────────────
@@ -144,6 +237,7 @@ if [ "$RAW_MODE" = true ]; then
  echo "$commit_list" | while IFS= read -r line; do
    echo "- ${line}"
  done
+  installation_section "$VERSION"
  exit 0
 fi

@@ -193,6 +287,7 @@ if [ -n "$release_title" ] && [ -n "$release_body" ]; then
  echo "# ${release_title}"
  echo ""
  echo "$release_body"
+  installation_section "$VERSION"
 else
  echo "Warning: JSON parsing failed, falling back to raw mode" >&2
  exec "$0" -r -v "$VERSION"