Merge pull request #152 from galaxyproject/dev_updates

More dev process updates - including history generation stuff, better uv usage, etc...

Author: jmchilton

.claude/commands/ready-release.md

@@ -0,0 +1,21 @@
+Walk me through readying a gxformat2 release. Run each step, check for problems, and pause if anything looks wrong.
+
+## Steps
+
+1. **Check git status** - ensure working tree is clean, no missing files.
+
+2. **Verify version** - read `gxformat2/__init__.py` and confirm `__version__` is a `.devN` variant of the intended release. Show me the current version and ask me to confirm the target release version.
+
+3. **Setup venv** - check `.venv` exists. If not, run `make setup-venv`. Confirm dev-requirements are installed.
+
+4. **Check UPSTREAM remote** - the Makefile defaults `UPSTREAM` to `galaxyproject`. Check if `$UPSTREAM` is set in the environment; if not, check if a git remote named `galaxyproject` exists. If it doesn't, check for `origin` or `upstream` remotes pointing to `galaxyproject/gxformat2` and offer to create a `galaxyproject` alias via `git remote add galaxyproject <url>`. This must be resolved before `make release` can push.
+
+5. **Add history** - run `make add-history` to pull contributions into HISTORY.rst under the .dev0 entry. Show me the new HISTORY.rst additions for review.
+
+6. **Lint** - run `make clean && make lint`. Report any failures.
+
+7. **Review** - show me a summary of outstanding uncommitted changes (if any) and ask if I want to commit them before proceeding.
+
+8. **Release** - after I confirm, run `make release` which does: commit-version, new-version, release-artifacts, push-release. This tags, bumps to next dev version, and pushes upstream.
+
+Stop after each step and report status before moving to the next.

Makefile

@@ -9,7 +9,7 @@ VENV?=.venv
 # Source virtualenv to execute command (flake8, sphinx, twine, etc...)
 IN_VENV=if [ -f $(VENV)/bin/activate ]; then . $(VENV)/bin/activate; fi;
 # TODO: add this upstream as a remote if it doesn't already exist.
-UPSTREAM?=jmchilton
+UPSTREAM?=galaxyproject
 SOURCE_DIR?=gxformat2
 BUILD_SCRIPTS_DIR=scripts
 DEV_RELEASE?=0
@@ -44,16 +44,12 @@ clean-test: ## remove test and coverage artifacts
 	rm -fr htmlcov/
 
 setup-venv: ## setup a development virutalenv in current directory
-	if [ ! -d $(VENV) ]; then \
-		if command -v uv > /dev/null 2>&1; then \
-			uv venv $(VENV); \
-		else \
-			python3 -m venv $(VENV); \
-		fi; \
-	fi
 	if command -v uv > /dev/null 2>&1; then \
-		$(IN_VENV) uv pip install -r requirements.txt && uv pip install -r dev-requirements.txt; \
+		uv sync --group test --group lint --group mypy; \
 	else \
+		if [ ! -d $(VENV) ]; then \
+			python3 -m venv $(VENV); \
+		fi; \
 		$(IN_VENV) pip install -r requirements.txt && pip install -r dev-requirements.txt; \
 	fi
 
@@ -137,7 +133,7 @@ push-release: ## Push a tagged release to github
 release: release-local push-release ## package, review, and upload a release
 
 add-history: ## Reformat HISTORY.rst with data from Github's API
-	$(IN_VENV) python $(BUILD_SCRIPTS_DIR)/bootstrap_history.py $(ITEM)
+	$(IN_VENV) python $(BUILD_SCRIPTS_DIR)/bootstrap_history.py --acknowledgements
 
 mypy:
 	MYPYPATH=mypy-stubs mypy gxformat2

scripts/bootstrap_history.py

@@ -2,6 +2,8 @@
 # Little script to make HISTORY.rst more easy to format properly, lots TODO
 # pull message down and embed, use arg parse, handle multiple, etc...
 import os
+import re
+import subprocess
 import sys
 import textwrap
 from urllib.parse import urljoin
@@ -21,6 +23,76 @@
 PROJECT_API = f"https://api.github.com/repos/{PROJECT_AUTHOR}/{PROJECT_NAME}/"
 
 
+def get_last_release_tag():
+    """Get the last release tag based on the current version in __init__.py"""
+    version = project.__version__
+    # Remove .dev0 suffix if present
+    if ".dev" in version:
+        version = version.split(".dev")[0]
+
+    # Parse version components
+    parts = version.split(".")
+    if len(parts) >= 3:
+        major, minor, patch = parts[:3]
+        # Decrement patch version to get last release
+        last_patch = max(0, int(patch) - 1)
+        return f"{major}.{minor}.{last_patch}"
+    return version
+
+
+def get_merge_commits_since_tag(tag):
+    """Get merge commits since the specified tag"""
+    try:
+        result = subprocess.run(
+            ["git", "log", "--merges", "--oneline", f"{tag}..HEAD"], capture_output=True, text=True, check=True
+        )
+        return result.stdout.strip().split("\n") if result.stdout.strip() else []
+    except subprocess.CalledProcessError:
+        return []
+
+
+def extract_pr_info_from_merge(merge_line):
+    """Extract PR number and author from merge commit message"""
+    # Match pattern: "Merge pull request #1234 from author/branch"
+    match = re.match(r"[a-f0-9]+\s+Merge pull request #(\d+) from ([^/]+)/", merge_line)
+    if match:
+        pr_number = match.group(1)
+        author = match.group(2)
+        return pr_number, author
+    return None, None
+
+
+def generate_acknowledgements():
+    """Generate acknowledgement lines for merge commits since last release"""
+    tag = get_last_release_tag()
+    merge_commits = get_merge_commits_since_tag(tag)
+
+    acknowledgements = []
+    for merge in merge_commits:
+        if merge.strip():
+            pr_number, author = extract_pr_info_from_merge(merge)
+            if pr_number and author:
+                try:
+                    # Get PR details from GitHub API
+                    api_url = urljoin(PROJECT_API, f"pulls/{pr_number}")
+                    req = requests.get(api_url).json()
+                    title = req.get("title", "")
+                    login = req["user"]["login"]
+
+                    # Format acknowledgement line
+                    title_clean = title.rstrip(".")
+                    ack_line = f"* {title_clean} (thanks to `@{login}`_). `Pull Request {pr_number}`_"
+                    acknowledgements.append(ack_line)
+
+                    # Add GitHub link
+                    github_link = f".. _Pull Request {pr_number}: {PROJECT_URL}/pull/{pr_number}"
+                    acknowledgements.append(github_link)
+                except Exception as e:
+                    print(f"Error processing PR {pr_number}: {e}", file=sys.stderr)
+
+    return acknowledgements
+
+
 def main(argv):
     history_path = os.path.join(PROJECT_DIRECTORY, "HISTORY.rst")
     with open(history_path, encoding="utf-8") as fh:
@@ -30,6 +102,37 @@ def extend(from_str, line):
         from_str += "\n"
         return history.replace(from_str, from_str + line + "\n")
 
+    # Check if we should generate acknowledgements for merge commits
+    if len(argv) > 1 and argv[1] == "--acknowledgements":
+        acknowledgements = generate_acknowledgements()
+        if acknowledgements:
+            print("Generated acknowledgement lines:")
+
+            # Find the unreleased section (current dev version)
+            current_version = project.__version__
+            unreleased_section_marker = f"---------------------\n{current_version}\n---------------------"
+
+            for ack in acknowledgements:
+                if ack.startswith("*"):
+                    print(ack)
+                    # Place acknowledgement lines in the unreleased section
+                    history = extend(unreleased_section_marker, ack)
+                elif ack.startswith(".."):
+                    print(ack)
+                    history = extend(".. github_links", ack)
+
+            with open(history_path, "w", encoding="utf-8") as fh:
+                fh.write(history)
+            print(f"\nAcknowledgements added to {history_path}")
+        else:
+            print("No merge commits found since last release.")
+        return
+
+    if len(argv) < 2:
+        print("Usage: python bootstrap_history.py <identifier> [message]")
+        print("   or: python bootstrap_history.py --acknowledgements")
+        return
+
     ident = argv[1]
 
     message = ""