Merge pull request #1561 from mvdbeek/build_and_release_script_updates

Build and release script updates

Author: mvdbeek

Makefile

@@ -74,9 +74,9 @@ test: ## run tests with the default Python (faster than tox)
 	$(IN_VENV) pytest $(TESTS)
 
 format: ## format Python code with ruff, black and isort
-	$(IN_VENV) ruff format planemo tests
-	$(IN_VENV) isort planemo tests
-	$(IN_VENV) black planemo tests
+	$(IN_VENV) ruff format planemo scripts tests
+	$(IN_VENV) isort planemo scripts tests
+	$(IN_VENV) black planemo scripts tests
 
 quick-test: ## run quickest tests with the default Python
 	$(IN_VENV) PLANEMO_SKIP_SLOW_TESTS=1 PLANEMO_SKIP_GALAXY_TESTS=1 pytest $(TESTS)
@@ -137,6 +137,8 @@ open-rtd: docs ## open docs on readthedocs.org
 open-project: ## open project on github
 	$(OPEN_RESOURCE) $(PROJECT_URL)
 
+check-dist: clean-build dist clean-build
+
 dist: clean submodule ## create and check packages
 	$(IN_VENV) python -m build
 	$(IN_VENV) twine check dist/*
@@ -169,10 +171,10 @@ push-release: ## Push a tagged release to github
 	git push $(UPSTREAM) master
 	git push --tags $(UPSTREAM)
 
-release: release-local push-release ## package, review, and upload a release
+release: release-local check-dist 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
 
 update-extern: ## update external artifacts copied locally
 	sh scripts/update_extern.sh

dev-requirements.txt

@@ -22,5 +22,6 @@ flake8
 isort
 
 # For release
+build
 wheel
 twine

docs/developing.rst

@@ -5,11 +5,11 @@ Release Checklist
 This page describes the process of releasing new versions of Planemo.
 
 * Review ``git status`` for missing files.
-* Verify the latest Travis CI builds pass.
-* Update ``HISTORY.rst`` with the help of ``scripts/bootstrap_history.py``
-* ``make open-docs`` and review changelog.
+* Verify the latest github workflows pass.
 * Ensure the target release is set correctly in ``planemo/__init__.py`` (
   ``version`` will be a ``devN`` variant of target release).
+* Update ``HISTORY.rst`` with the help of ``make add-history`` ``scripts/bootstrap_history.py``
+* ``make open-docs`` and review changelog.
 * ``make clean && make lint && make test``
 * Commit outstanding changes.
 * Update version and history, commit, add tag, mint a new version and push

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 = ""