Merge PR ceph#65217 into main

* refs/pull/65217/head:
	.github: pass GITHUB_TOKEN to redmine-upkeep
	.github/workflows: remove unnecessary permissions for leaving PR comments
	script/redmine-upkeep: pass token to auth
	script/redmine-upkeep: cleanup formatting for github comment

Reviewed-by: Ernesto Puerta <[email protected]>

Author: batrick

.github/workflows/redmine-upkeep.yml

@@ -39,9 +39,6 @@ jobs:
     runs-on: ubuntu-latest
     # This condition ensures the job only runs in the main ceph/ceph repository and only on the specified branches.
     if: github.repository == 'ceph/ceph' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/feature/redmine-upkeep')
-    permissions:
-      # To allow writing comments on PRs:
-      issues: write
     steps:
       - name: Checkout main branch for pull_request_target
         if: github.event_name == 'pull_request_target'
@@ -87,6 +84,7 @@ jobs:
              --git-dir=./ceph/
         env:
           REDMINE_API_KEY: ${{ secrets.REDMINE_API_KEY_BACKPORT_BOT }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Run redmine-upkeep via test push
         if: github.event_name == 'push' && github.ref == 'refs/heads/feature/redmine-upkeep'
@@ -96,6 +94,7 @@ jobs:
              --git-dir=./ceph/
         env:
           REDMINE_API_KEY: ${{ secrets.REDMINE_API_KEY_BACKPORT_BOT }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Run redmine-upkeep via merge on pull_request_target
         if: github.event_name == 'pull_request_target' && github.event.pull_request.merged == true
@@ -107,3 +106,4 @@ jobs:
              --merge-commit=${{ github.event.pull_request.merge_commit_sha }}
         env:
           REDMINE_API_KEY: ${{ secrets.REDMINE_API_KEY_BACKPORT_BOT }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

src/script/redmine-upkeep.py

@@ -47,7 +47,6 @@
 
 GITHUB_ACTION_LOG = f"{GITHUB_SERVER_URL}/{GITHUB_REPOSITORY}/actions/runs/{GITHUB_RUN_ID}"
 
-GITHUB_USER = os.getenv("GITHUB_USER", os.getenv("GITHUB_USER", getuser()))
 GITHUB_API_ENDPOINT = f"https://api.github.com/repos/{GITHUB_REPOSITORY}"
 
 REDMINE_CUSTOM_FIELD_ID_BACKPORT = 2
@@ -112,8 +111,10 @@ def process(self, msg, kwargs):
 log.addHandler(log_stream)
 log.setLevel(logging.INFO)
 
-def gitauth():
-    return (GITHUB_USER, GITHUB_TOKEN)
+GITHUB_HEADERS = {
+    "Authorization": f"Bearer {GITHUB_TOKEN}",
+    "X-GitHub-Api-Version": "2022-11-28",
+}
 
 def post_github_comment(session, pr_id, body):
     """Helper to post a comment to a GitHub PR."""
@@ -125,7 +126,7 @@ def post_github_comment(session, pr_id, body):
     endpoint = f"{GITHUB_API_ENDPOINT}/issues/{pr_id}/comments"
     payload = {'body': body}
     try:
-        response = session.post(endpoint, auth=gitauth(), json=payload)
+        response = session.post(endpoint, headers=GITHUB_HEADERS, json=payload)
         response.raise_for_status()
         log.info(f"Successfully posted comment to PR #{pr_id}.")
         return True
@@ -341,7 +342,7 @@ def fetch_pr(self):
         endpoint = f"{GITHUB_API_ENDPOINT}/pulls/{pr_id}"
         params = {}
         try:
-            response = self.github_session.get(endpoint, auth=gitauth(), params=params)
+            response = self.github_session.get(endpoint, headers=GITHUB_HEADERS, params=params)
             response.raise_for_status()
             pr_data = response.json()
             self.logger.debug("PR #%d json:\n%s", pr_id, pr_data)
@@ -1244,18 +1245,15 @@ def _execute_pull_request(self):
 
             This is an automated message by src/script/redmine-upkeep.py.
 
-            I found one or more 'Fixes:' tags in the commit messages in
+            I found one or more `Fixes:` tags in the commit messages in
 
             `git log {revrange}`
 
             The referenced tickets are:
 
             {tracker_links}
 
-            Those tickets do not reference this merged Pull Request. If this
-            Pull Request merge resolves any of those tickets, please update the
-            "Pull Request ID" field on each ticket. A future run of this
-            script will appropriately update them.
+            Those tickets do not reference this merged Pull Request. If this Pull Request merge resolves any of those tickets, please update the "Pull Request ID" field on each ticket. A future run of this script will appropriately update them.
 
             Update Log: {GITHUB_ACTION_LOG}
 
@@ -1398,6 +1396,10 @@ def main():
         log.fatal("REDMINE_API_KEY not found! Please set REDMINE_API_KEY environment variable or ~/.redmine_key.")
         sys.exit(1)
 
+    if GITHUB_TOKEN is None:
+        log.fatal("GITHUB_TOKEN not found! Please set GITHUB_TOKEN environment variable or ~/.github_token.")
+        sys.exit(1)
+
     if IS_GITHUB_ACTION and GITHUB_REPOSITORY != "ceph/ceph":
         log.fatal("refusing to run ceph/ceph.git github action for repository {GITHUB_REPOSITORY}")
         sys.exit(0)