Add sync support for dev branches and tune PR description #15
Conversation
dagood
force-pushed
the
dev/dagood/fips-branch-sync
branch
from
67b698a
to
a8746fb
Compare
dagood
force-pushed
the
dev/dagood/fips-branch-sync
branch
from
a8746fb
to
176989d
Compare
cmd/sync/sync.go
Outdated
| @@ -126,6 +131,21 @@ func main() { | |||
| } | |||
| } | |||
|
|
|||
| // createAuthorizedGitUrl takes a URL, auth options, and returns an authorized URL. The authorized | |||
| // URL may be the same as the original URL, depending on the options given and the URL content. | |||
| func createAuthorizedGitUrl(url string, gitAuthSSH bool, gitAuthPAT bool) string { | |||
There was a problem hiding this comment.
Nit: it feels weird to be allowed to pass two option flags, but have one of them ignored if the other is true. Does this ever get called with both false? Feels like it might be better to have just a single 'usSSH' and then fall back to PAT if not true?
There was a problem hiding this comment.
I guess currently it wouldn't happen because our fork repos are private and need auth, but false, false would be for running a sync locally and not actually pushing a PR anywhere. (The Go upstream repos don't require any auth for fetching.) But yeah, this is not a good API--there are only three "real" states for four input values. Should really be an enum or similar.
I'll try changing the bool command line options -git-auth-ssh , -git-auth-pat to -git-auth ssh, -git-auth pat to drive this change all the way through.
There was a problem hiding this comment.
This func now takes a GitAuthOption (just a typed string) and compares against typed consts in a switch. Help looks like this:
$ go run ./cmd/sync -git-auth wrong
Error: git-auth value 'wrong' is not an accepted value.
[...]
-git-auth string
The type of Git auth to inject into upstream and target GitHub URLs for fetch/push access. String options:
none - Leave GitHub URLs as they are. Git may use HTTPS authentication in this case.
ssh - Change the GitHub URL to SSH format.
pat - Add the 'github-user' and 'github-pat' values into the URL.
(default "none")
-github-pat string
Submit the PR with this GitHub PAT, if specified.
[...]
This PR adds automatic merges from
microsoft/release-branch.go1.17intodev/official/go1.17-openssl-fips.I touched up the PR description a bit. The main change was to truncate the diff after 200 lines to avoid potential issues with unbounded output. (See code comment.) I went after this right now because with dev branches, the diff could get very large depending on what's being worked on. While I was there, added a couple more things:
Example PR: dagood/go#9