build: Improve CHANGELOG mentions and token usage

This commit improves the release-patch target to mention users in the
Miscellaneous section and warn if a GitHub token is not provided.

Signed-off-by: Torin Sandall <torinsandall@gmail.com>
This commit is contained in:
Torin Sandall
2021-11-29 16:21:49 -08:00
parent 7f73ac1dfe
commit 6e7f271bb7
3 changed files with 13 additions and 5 deletions
+4
View File
@@ -429,7 +429,11 @@ check-go-module:
.PHONY: release-patch
release-patch:
ifeq ($(GITHUB_TOKEN),)
@echo "\033[0;31mGITHUB_TOKEN environment variable missing.\033[33m Provide a GitHub Personal Access Token (PAT) with the 'read:org' scope.\033[0m"
endif
@$(DOCKER) run $(DOCKER_FLAGS) \
-e GITHUB_TOKEN=$(GITHUB_TOKEN) \
-e LAST_VERSION=$(LAST_VERSION) \
-v $(PWD):/_src \
python:2.7 \
+9 -4
View File
@@ -1,9 +1,10 @@
#!/usr/bin/env python
#!/usr/bin/env python2
"""
changelog.py helps generate the CHANGELOG.md message for a particular release.
"""
import argparse
import os
import subprocess
import shlex
import re
@@ -122,14 +123,16 @@ def get_subject(commit_message):
return commit_message.splitlines()[0]
def get_changelog_message(commit_message, issue_id, mention, reporter, repo_url):
subject = get_subject(commit_message)
if issue_id:
subject = get_subject(commit_message)
if mention:
mention = " "+mention
if reporter:
reporter = " "+reporter
return "Fixes", "{subject} ([#{issue_id}]({repo_url}/issues/{issue_id})){mention}{reporter}".format(subject=subject, issue_id=issue_id, repo_url=repo_url, mention=mention, reporter=reporter)
return None, get_subject(commit_message)
if mention:
mention = " (" + mention + ")"
return None, "{subject}{mention}".format(subject=subject, mention=mention)
def get_latest_tag():
@@ -138,10 +141,12 @@ def get_latest_tag():
def parse_args():
if "GITHUB_TOKEN" in os.environ:
default_token = os.environ["GITHUB_TOKEN"]
parser = argparse.ArgumentParser()
parser.add_argument(
"--repo_url", default="https://github.com/open-policy-agent/opa")
parser.add_argument("--token", default="", help="GitHub API token")
parser.add_argument("--token", default=default_token, help="GitHub API token")
parser.add_argument("from_version", nargs="?",
default=get_latest_tag(), help="start of changes")
parser.add_argument("to_commit", nargs="?",
-1
View File
@@ -66,7 +66,6 @@ $(./build/changelog.py $LAST_VERSION HEAD)
$(awk '/^##/{f=1}f' CHANGELOG.md)
EOF
fi
mv _CHANGELOG.md CHANGELOG.md
}