WT-13560 Deprecate SSH Cloning of Git repositories #11068

lukech · 2024-10-03T02:10:43Z

Replace the existing SSH clones (i.e. git clone git@//github.com//) with either HTTP clones or the github.generate_token Evergreen project command, to support the deprecation of SSH cloning in Evergreen.

Please note the change will need to be backported to all supported release branches.

github-actions · 2024-10-03T02:10:55Z

What makes this change safe?

A good answer to this question helps the reviewers understand where they should focus their attention, so please consider these questions:

Is the change risky or not? Why?
Low-risk change as it's only affecting Evergreen tests.
What tests are you adding or changing? Why?
No new test is added. Existing tests should be enough to verify the change.
What existing tests are you relying on?
The configure-combinations and long-test Evergreen tasks, both of which call the "get automation-scripts" func.
What, if anything, are you concerned about that you'd like the reviewer to focus on?
Commented on the PR.

References:

Checklist before requesting a review

I have performed a self-review of my code.
I have made corresponding changes to the documentation (if applicable).
I have added/updated tests that demonstrate my fix is effective or that my feature works correctly.

lukech · 2024-10-03T02:17:01Z

test/evergreen.yml

@@ -544,7 +555,7 @@ functions:
            exit 0
          fi

-          git clone git@github.com:wiredtiger/wiredtiger.github.com.git
+          git clone https://github.com/wiredtiger/wiredtiger.github.com.git


wiredtiger/wiredtiger.github.com is a public repo so https clone should work. The following shell.exec command has already taken care of the token generation from github app (in a more manual way than the github.generate_token Evergreen command).

lukech · 2024-10-03T02:18:18Z

test/evergreen.yml

@@ -128,6 +128,15 @@ functions:
    type: setup
    params:
      directory: wiredtiger
+  "generate github token": &gen_github_token
+    command: github.generate_token


The Github app has been provisioned in the "WiredTiger (develop)" Evergreen project to enable this command invocation.

ajmorton

LGTM 👍
Some thoughts. No actions required.

ajmorton · 2024-10-03T05:04:44Z

src/docs/build-posix.dox

@@ -21,7 +21,7 @@ We also suggest <a href="https://ninja-build.org/">Ninja</a> and
 First, clone the repository:

 @code
-git clone git://github.com/wiredtiger/wiredtiger.git
+git clone https://github.com/wiredtiger/wiredtiger.git


Take this as a note and not an addressable comment. I believe https:// cloning was deprecated a while back, so developers that use https:// to clone on their workstations don't have permission to push branches to GitHub.

I don't think it's an issue for external contributors but I'm curious if this will impact new WT devs.
I have a new MacBook I'll set up in a week or so. I can investigate this then. Feel free to merge in the meantime

Good point. I assume this public doc is mainly targeted at external contributors, who may run into issues with SSH clone (as they are not members of the repo). I double-checked our internal wiki and it does write SSH clone (which is good).

ajmorton · 2024-10-03T05:07:26Z

src/docs/build-posix.dox

@@ -21,7 +21,7 @@ We also suggest <a href="https://ninja-build.org/">Ninja</a> and
 First, clone the repository:


General note: The commit messages say WT-13506 not WT-13560. This should be ok as we use the PR title for merge.

Good catch. It was a typo in the commit title.

ajmorton · 2024-10-03T05:10:26Z

test/multiversion/wt_multiversion.sh

@@ -5,7 +5,7 @@ last_stable_dir=wiredtiger_${last_stable}/
 last_stable_branch=mongodb-${last_stable}

 function setup_last_stable {
-    git clone [email protected]:wiredtiger/wiredtiger.git ${last_stable_dir}


I don't see an evergreen config that calls this file. Do you know where it's executed from?
edit: The test talks about 4.2 and 4.4 and hasn't been touched in 4 years. Perhaps it was missed in the migration from Jenkins to Evergreen

You could be right. Not sure if anyone uses this script locally. This change is optional with the motivation of aligning the git clone method with other places.

ajmorton · 2024-10-03T05:10:47Z

test/compatibility/common/compatibility_common.py

@@ -121,7 +121,7 @@ def prepare_branch(branch, config):
            print(f'Branch {branch} is already cloned')
            system(f'git -C "{path}" pull')
        else:
-            source = '[email protected]:wiredtiger/wiredtiger.git'


I've added compatibility-test-suite to the PR testing so we execute this new code

jbergler · 2024-10-03T18:24:59Z

test/evergreen.yml

@@ -136,8 +145,9 @@ functions:
      script: |
        set -o errexit
        set -o verbose
+        echo "generated_token: ${generated_token}"


Good catch. Removed in ef6f023

Replace the existing SSH clones (i.e. git clone git@//github.com/<org>/<repo>) with either HTTP clones or the `github.generate_token` Evergreen project command, to support the deprecation of SSH cloning in Evergreen. Please note the change will need to be backported to all supported release branches. (cherry picked from commit f3cb304)

lukech added 2 commits September 25, 2024 18:27

WT-13506 Deprecate SSH Cloning in favor of Github App

a8a8459

WT-13560 Deprecate SSH Cloning of Git repositories

1fb56b8

lukech changed the title ~~Wt-13560-deprecate-ssh-cloning~~ WT-13560 Deprecate SSH Cloning of Git repositories Oct 3, 2024

Fix the https urls

728f832

lukech commented Oct 3, 2024

View reviewed changes

Add back patchable setting for doc-update task

eb43b99

lukech requested review from jbergler and ajmorton October 3, 2024 03:26

ajmorton approved these changes Oct 3, 2024

View reviewed changes

jbergler reviewed Oct 3, 2024

View reviewed changes

Remove a leftover line

ef6f023

jbergler approved these changes Oct 4, 2024

View reviewed changes

lukech added this pull request to the merge queue Oct 4, 2024

Merged via the queue into develop with commit f3cb304 Oct 4, 2024
10 checks passed

lukech deleted the wt-13560-deprecate-ssh-cloning branch October 4, 2024 03:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WT-13560 Deprecate SSH Cloning of Git repositories #11068

WT-13560 Deprecate SSH Cloning of Git repositories #11068

lukech commented Oct 3, 2024 •

edited

Loading

github-actions bot commented Oct 3, 2024 •

edited by lukech

Loading

lukech Oct 3, 2024

lukech Oct 3, 2024

ajmorton left a comment

ajmorton Oct 3, 2024

lukech Oct 3, 2024

ajmorton Oct 3, 2024

lukech Oct 3, 2024

ajmorton Oct 3, 2024 •

edited

Loading

lukech Oct 3, 2024

ajmorton Oct 3, 2024 •

edited

Loading

jbergler Oct 3, 2024

lukech Oct 3, 2024

		@@ -21,7 +21,7 @@ We also suggest <a href="https://ninja-build.org/">Ninja</a> and
		First, clone the repository:

WT-13560 Deprecate SSH Cloning of Git repositories #11068

WT-13560 Deprecate SSH Cloning of Git repositories #11068

Conversation

lukech commented Oct 3, 2024 • edited Loading

github-actions bot commented Oct 3, 2024 • edited by lukech Loading

What makes this change safe?

Checklist before requesting a review

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ajmorton left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ajmorton Oct 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ajmorton Oct 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lukech commented Oct 3, 2024 •

edited

Loading

github-actions bot commented Oct 3, 2024 •

edited by lukech

Loading

ajmorton Oct 3, 2024 •

edited

Loading

ajmorton Oct 3, 2024 •

edited

Loading