Merge pull request #62 from github/source-url-flag

chrisgavin · web-flow · commit 06cf2d347b83 · 2022-03-23T17:17:27.000Z
Add a hidden flag to fetch from an alternative Git source.
diff --git a/cmd/pull.go b/cmd/pull.go
@@ -13,16 +13,19 @@ var pullCmd = &cobra.Command{
 	RunE: func(cmd *cobra.Command, args []string) error {
 		version.LogVersion()
 		cacheDirectory := cachedirectory.NewCacheDirectory(rootFlags.cacheDir)
-		return pull.Pull(cmd.Context(), cacheDirectory, pullFlags.sourceToken)
+		return pull.Pull(cmd.Context(), cacheDirectory, pullFlags.sourceToken, pullFlags.sourceURL)
 	},
 }
 
 type pullFlagFields struct {
 	sourceToken string
+	sourceURL   string
 }
 
 var pullFlags = pullFlagFields{}
 
 func (f *pullFlagFields) Init(cmd *cobra.Command) {
 	cmd.Flags().StringVar(&f.sourceToken, "source-token", "", "A token to access the API of GitHub.com. This is normally not required, but can be provided if you have issues with API rate limiting.")
+	cmd.Flags().StringVar(&f.sourceURL, "source-url", "", "Use a custom Git URL for fetching the Action repository contents from. The CodeQL bundles will still be fetched from GitHub.com.")
+	cmd.Flags().MarkHidden("source-url")
 }
diff --git a/cmd/sync.go b/cmd/sync.go
@@ -14,7 +14,7 @@ var syncCmd = &cobra.Command{
 	RunE: func(cmd *cobra.Command, args []string) error {
 		version.LogVersion()
 		cacheDirectory := cachedirectory.NewCacheDirectory(rootFlags.cacheDir)
-		err := pull.Pull(cmd.Context(), cacheDirectory, pullFlags.sourceToken)
+		err := pull.Pull(cmd.Context(), cacheDirectory, pullFlags.sourceToken, pullFlags.sourceURL)
 		if err != nil {
 			return err
 		}
diff --git a/internal/pull/pull.go b/internal/pull/pull.go
@@ -29,7 +29,7 @@ import (
 
 const sourceOwner = "github"
 const sourceRepository = "codeql-action"
-const sourceURL = "https://github.com/" + sourceOwner + "/" + sourceRepository + ".git"
+const defaultSourceURL = "https://github.com/" + sourceOwner + "/" + sourceRepository + ".git"
 
 var relevantReferences = regexp.MustCompile("^refs/(heads|tags)/(main|v\\d+)$")
 
@@ -254,7 +254,7 @@ func (pullService *pullService) pullReleases() error {
 	return nil
 }
 
-func Pull(ctx context.Context, cacheDirectory cachedirectory.CacheDirectory, sourceToken string) error {
+func Pull(ctx context.Context, cacheDirectory cachedirectory.CacheDirectory, sourceToken string, sourceURL string) error {
 	err := cacheDirectory.CheckOrCreateVersionFile(true, version.Version())
 	if err != nil {
 		return err
@@ -272,6 +272,10 @@ func Pull(ctx context.Context, cacheDirectory cachedirectory.CacheDirectory, sou
 		tokenClient = oauth2.NewClient(ctx, tokenSource)
 	}
 
+	if sourceURL == "" {
+		sourceURL = defaultSourceURL
+	}
+
 	pullService := pullService{
 		ctx:                ctx,
 		cacheDirectory:     cacheDirectory,

Original file line number	Diff line number	Diff line change
`@@ -13,16 +13,19 @@ var pullCmd = &cobra.Command{`
`13`	`13`	`RunE: func(cmd *cobra.Command, args []string) error {`
`14`	`14`	`version.LogVersion()`
`15`	`15`	`cacheDirectory := cachedirectory.NewCacheDirectory(rootFlags.cacheDir)`
`16`		`- return pull.Pull(cmd.Context(), cacheDirectory, pullFlags.sourceToken)`
	`16`	`+ return pull.Pull(cmd.Context(), cacheDirectory, pullFlags.sourceToken, pullFlags.sourceURL)`
`17`	`17`	`},`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`type pullFlagFields struct {`
`21`	`21`	`sourceToken string`
	`22`	`+ sourceURL string`
`22`	`23`	`}`
`23`	`24`
`24`	`25`	`var pullFlags = pullFlagFields{}`
`25`	`26`
`26`	`27`	`func (f pullFlagFields) Init(cmd cobra.Command) {`
`27`	`28`	`cmd.Flags().StringVar(&f.sourceToken, "source-token", "", "A token to access the API of GitHub.com. This is normally not required, but can be provided if you have issues with API rate limiting.")`
	`29`	`+ cmd.Flags().StringVar(&f.sourceURL, "source-url", "", "Use a custom Git URL for fetching the Action repository contents from. The CodeQL bundles will still be fetched from GitHub.com.")`
	`30`	`+ cmd.Flags().MarkHidden("source-url")`
`28`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ var syncCmd = &cobra.Command{`
`14`	`14`	`RunE: func(cmd *cobra.Command, args []string) error {`
`15`	`15`	`version.LogVersion()`
`16`	`16`	`cacheDirectory := cachedirectory.NewCacheDirectory(rootFlags.cacheDir)`
`17`		`- err := pull.Pull(cmd.Context(), cacheDirectory, pullFlags.sourceToken)`
	`17`	`+ err := pull.Pull(cmd.Context(), cacheDirectory, pullFlags.sourceToken, pullFlags.sourceURL)`
`18`	`18`	`if err != nil {`
`19`	`19`	`return err`
`20`	`20`	`}`