USHFT-2969: Release notes job: use token for `git` commands #3236

pmtk · 2024-04-15T08:58:34Z

When ci-operator clones the repository it does not include any credentials to talk back to the repository.
To be able to execute git push we need to add a special remote that will use token that is either supplied (personal) or generated (Installation Access Token, IAT).

openshift-ci-robot · 2024-04-15T08:58:36Z

@pmtk: No Jira issue with key USHFT-2969 exists in the tracker at https://issues.redhat.com/.
Once a valid jira issue is referenced in the title of this pull request, request a refresh with /jira refresh.

In response to this:

When ci-operator clones the repository it does not include any credentials to talk back to the repository.
To be able to execute git push we need to add a special remote that will use token that is either supplied (personal) or generated (Installation Access Token, IAT).

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

pmtk · 2024-04-15T08:58:44Z

/assign @dhellmann

ggiguash · 2024-04-15T09:51:34Z

scripts/release-notes/gen_ec_release_notes.py

+    env = {}
+    env.update(os.environ)
+
+    print(f'git remote remote {REMOTE}')


Suggested change

print(f'git remote remote {REMOTE}')

print(f'git remote remove {REMOTE}')

Right, thx!

ggiguash · 2024-04-15T09:52:06Z

scripts/release-notes/gen_ec_release_notes.py

@@ -404,6 +407,28 @@ def tag_exists(release_name):
        return False


+def add_token_remote():
+    """
+    Returns the Git remote for the given repository using


Suggested change

Returns the Git remote for the given repository using

Adds the Git remote to the given repository using

ggiguash · 2024-04-15T09:54:56Z

scripts/release-notes/gen_ec_release_notes.py

@@ -486,14 +511,18 @@ def publish_release(new_release, take_action):
    # Create draft release with message that includes download URLs and history
    try:
        github_release_create(release_name, notes)
+    except urllib.error.URLError as e:
+        print(f"Failed to create the release {release_name}: {e}")
+        print(f"Response: {str(e.fp.readlines())}")


Should we add response printout the to catch-all handler?

I think it's a different type so it doesn't have these fields

https://docs.python.org/3/library/urllib.error.html#urllib.error.HTTPError.fp

Can you explain when this exception is thrown?

For me it when I tested and the release was already present. Original log would only say: Failed to create the release 4.16.0-ec.1-202401101824.p0: HTTP Error 422: Unprocessable Entity and the hint that there already was a release was in the response body of the HTTP request.
But I suspect this exception could happen any other time that HTTP request wasn't successful (i.e. 200) and without response's body we have not enough info to work on it.

pmtk · 2024-04-15T13:33:12Z

/retest

scripts/release-notes/gen_ec_release_notes.py

When ci-operator clones the repository it does not include any credentials to talk back to the repository. To be able to execute `git push` we need to add a special remote that will use token that is either supplied (Personal) or generated (installation access token).

pmtk · 2024-04-16T13:10:06Z

/retest

dhellmann

/lgtm

dhellmann · 2024-04-16T13:46:02Z

scripts/release-notes/gen_ec_release_notes.py

+    )
+    if result.returncode != 0:
+        err = result.stderr.replace(GITHUB_TOKEN, "") if result.stderr else "stderr is empty"
+        raise Exception(f"Command `git remote add` failed: {err}")


You could use CalledProcessError, like on line 459, but I wouldn't hold this up over it.

I noticed it, but didn't quite fit here - I didn't want to put cmd in there and redact two things

openshift-ci · 2024-04-16T13:53:55Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dhellmann, pmtk

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [dhellmann,pmtk]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

openshift-ci-robot · 2024-04-16T14:45:18Z

/retest-required

Remaining retests: 0 against base HEAD 871297a and 2 for PR HEAD 8874b1a in total

openshift-ci · 2024-04-16T19:40:23Z

@pmtk: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

openshift-ci bot assigned dhellmann Apr 15, 2024

openshift-ci bot requested review from dhellmann and ggiguash April 15, 2024 09:01

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 15, 2024

ggiguash reviewed Apr 15, 2024

View reviewed changes

pmtk force-pushed the release-notes-job/use-token-for-git-commands branch 2 times, most recently from 926b1e2 to 6cec94b Compare April 15, 2024 10:09

dhellmann reviewed Apr 15, 2024

View reviewed changes

scripts/release-notes/gen_ec_release_notes.py Outdated Show resolved Hide resolved

pmtk force-pushed the release-notes-job/use-token-for-git-commands branch from 6cec94b to 4854bfb Compare April 16, 2024 07:36

pmtk added 3 commits April 16, 2024 09:39

Use GITHUB_ vars for API requests

6f8bb4f

Capture GH API exception response

8874b1a

pmtk force-pushed the release-notes-job/use-token-for-git-commands branch from 4854bfb to 8874b1a Compare April 16, 2024 07:39

dhellmann reviewed Apr 16, 2024

View reviewed changes

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Apr 16, 2024

openshift-merge-bot bot merged commit 9af9ccd into openshift:main Apr 16, 2024

pmtk deleted the release-notes-job/use-token-for-git-commands branch April 24, 2024 08:09

	print(f'git remote remote {REMOTE}')
	print(f'git remote remove {REMOTE}')

	Returns the Git remote for the given repository using
	Adds the Git remote to the given repository using

USHFT-2969: Release notes job: use token for git commands #3236

USHFT-2969: Release notes job: use token for git commands #3236

Uh oh!

Conversation

pmtk commented Apr 15, 2024

Uh oh!

openshift-ci-robot commented Apr 15, 2024

Uh oh!

pmtk commented Apr 15, 2024

Uh oh!

ggiguash Apr 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pmtk Apr 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pmtk commented Apr 15, 2024

Uh oh!

Uh oh!

pmtk commented Apr 16, 2024

Uh oh!

dhellmann left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

openshift-ci bot commented Apr 16, 2024

Uh oh!

openshift-ci-robot commented Apr 16, 2024

Uh oh!

openshift-ci bot commented Apr 16, 2024

Uh oh!

Uh oh!

USHFT-2969: Release notes job: use token for `git` commands #3236

USHFT-2969: Release notes job: use token for `git` commands #3236

ggiguash Apr 15, 2024 •

edited

Loading

pmtk Apr 15, 2024 •

edited

Loading