Move changelog and CI over to GHI

fixes: #354

Author: gerrod3

.ci/scripts/release.py

@@ -6,65 +6,11 @@
 # For more info visit https://github.com/pulp/plugin_template
 
 import argparse
-import json
 import re
 import os
 import textwrap
-from collections import defaultdict
-from pathlib import Path
 
 from git import Repo
-from redminelib import Redmine
-from redminelib.exceptions import ResourceAttrError
-
-
-REDMINE_URL = "https://pulp.plan.io"
-REDMINE_QUERY_URL = f"{REDMINE_URL}/issues?set_filter=1&status_id=*&issue_id="
-
-
-def validate_redmine_data(redmine_query_url, redmine_issues):
-    """Validate redmine milestone."""
-    redmine = Redmine("https://pulp.plan.io")
-    project_set = set()
-    stats = defaultdict(list)
-    milestone_url = "\n[noissue]"
-    milestone_id = None
-    for issue in redmine_issues:
-        redmine_issue = redmine.issue.get(int(issue))
-
-        project_name = redmine_issue.project.name
-        project_set.update([project_name])
-        stats[f"project_{project_name.lower().replace(' ', '_')}"].append(issue)
-
-        status = redmine_issue.status.name
-        if "CLOSE" not in status and status != "MODIFIED":
-            stats["status_not_modified"].append(issue)
-
-        try:
-            milestone = redmine_issue.fixed_version.name
-            milestone_id = redmine_issue.fixed_version.id
-            stats[f"milestone_{milestone}"].append(issue)
-        except ResourceAttrError:
-            stats["without_milestone"].append(issue)
-
-    if milestone_id is not None:
-        milestone_url = f"Redmine Milestone: {REDMINE_URL}/versions/{milestone_id}.json\n[noissue]"
-
-    print(f"\n\nRedmine stats: {json.dumps(stats, indent=2)}")
-    error_messages = []
-    if stats.get("status_not_modified"):
-        error_messages.append(f"One or more issues are not MODIFIED {stats['status_not_modified']}")
-    if stats.get("without_milestone"):
-        error_messages.append(
-            f"One or more issues are not associated with a milestone {stats['without_milestone']}"
-        )
-    if len(project_set) > 1:
-        error_messages.append(f"Issues with different projects - {project_set}")
-    if error_messages:
-        error_messages.append(f"Verify at {redmine_query_url}")
-        raise RuntimeError("\n".join(error_messages))
-
-    return milestone_url
 
 
 release_path = os.path.dirname(os.path.abspath(__file__))
@@ -81,17 +27,6 @@ def validate_redmine_data(redmine_query_url, redmine_issues):
 release_version = version.replace(".dev", "")
 
 
-issues_to_close = []
-for filename in Path(f"{plugin_path}/CHANGES").rglob("*"):
-    if filename.stem.isdigit():
-        issue = filename.stem
-        issue_url = f"{REDMINE_URL}/issues/{issue}.json"
-        issues_to_close.append(issue)
-
-issues = ",".join(issues_to_close)
-redmine_final_query = f"{REDMINE_QUERY_URL}{issues}"
-milestone_url = validate_redmine_data(redmine_final_query, issues_to_close)
-
 helper = textwrap.dedent(
     """\
         Start the release process.
@@ -165,10 +100,9 @@ def validate_redmine_data(redmine_query_url, redmine_issues):
 git.add(f"{plugin_path}/setup.py")
 git.add(f"{plugin_path}/requirements.txt")
 git.add(f"{plugin_path}/.bumpversion.cfg")
-git.commit(
-    "-m",
-    f"Release {release_version}\n\nRedmine Query: {redmine_final_query}\n{milestone_url}",
-)
+
+git.commit("-m", f"Release {release_version}")
+
 
 sha = repo.head.object.hexsha
 short_sha = git.rev_parse(sha, short=7)
@@ -199,6 +133,6 @@ def validate_redmine_data(redmine_query_url, redmine_issues):
 git.add(f"{plugin_path}/.bumpversion.cfg")
 git.commit("-m", f"Bump to {new_dev_version}\n\n[noissue]")
 
-print(f"\n\nRedmine query of issues to close:\n{redmine_final_query}")
+
 print(f"Release commit == {short_sha}")
 print(f"All changes were committed on branch: release_{release_version}")

.ci/scripts/validate_commit_message.py

@@ -6,38 +6,30 @@
 # For more info visit https://github.com/pulp/plugin_template
 
 import re
-import requests
+
 import subprocess
 import sys
 from pathlib import Path
 
-KEYWORDS = ["fixes", "closes", "re", "ref"]
+from github import Github
+
+KEYWORDS = ["fixes", "closes"]
 NO_ISSUE = "[noissue]"
-STATUSES = ["NEW", "ASSIGNED", "POST", "MODIFIED"]
-REDMINE_URL = "https://pulp.plan.io"
 CHANGELOG_EXTS = [".feature", ".bugfix", ".doc", ".removal", ".misc", ".deprecation"]
 
 sha = sys.argv[1]
-project = ""
 message = subprocess.check_output(["git", "log", "--format=%B", "-n 1", sha]).decode("utf-8")
 
+g = Github()
+repo = g.get_repo("pulp/pulp_python")
 
-def __check_status(issue):
-    response = requests.get(f"{REDMINE_URL}/issues/{issue}.json")
-    response.raise_for_status()
-    bug_json = response.json()
-    status = bug_json["issue"]["status"]["name"]
-    if status not in STATUSES:
-        sys.exit(
-            "Error: issue #{issue} has invalid status of {status}. Status must be one of "
-            "{statuses}.".format(issue=issue, status=status, statuses=", ".join(STATUSES))
-        )
 
-    if project:
-        project_id = bug_json["issue"]["project"]["id"]
-        project_json = requests.get(f"{REDMINE_URL}/projects/{project_id}.json").json()
-        if project_json["project"]["identifier"] != project:
-            sys.exit(f"Error: issue {issue} is not in the {project} project.")
+def __check_status(issue):
+    gi = repo.get_issue(int(issue))
+    if gi.pull_request:
+        sys.exit(f"Error: issue #{issue} is a pull request.")
+    if gi.closed_at:
+        sys.exit(f"Error: issue #{issue} is closed.")
 
 
 def __check_changelog(issue):

.github/workflows/scripts/check_commit.sh

@@ -14,6 +14,9 @@ set -euv
 
 echo ::group::REQUESTS
 pip3 install requests
+
+pip3 install pygithub
+
 echo ::endgroup::
 
 for sha in $(curl $GITHUB_CONTEXT | jq '.[].sha' | sed 's/"//g')

CHANGES/354.misc

@@ -0,0 +1 @@
+Move changelog template and issue checker workflow to GitHub Issues

pyproject.toml

@@ -4,7 +4,7 @@ filename = "CHANGES.rst"
 directory = "CHANGES/"
 title_format = "{version} ({project_date})"
 template = "CHANGES/.TEMPLATE.rst"
-issue_format = "`#{issue} <https://pulp.plan.io/issues/{issue}>`_"
+issue_format = "`#{issue} <https://github.com/pulp/pulp_python/issues/{issue}>`_"
 
 [tool.check-manifest]
 ignore = [

template_config.yml

@@ -16,6 +16,7 @@ deploy_daily_client_to_rubygems: true
 deploy_to_pypi: true
 docker_fixtures: false
 docs_test: true
+issue_tracker: github
 plugin_app_label: python
 plugin_camel: PulpPython
 plugin_camel_short: Python