Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to ensure that a repository has been synced to the Github servers? #3366

Open
herzrasen opened this issue Dec 3, 2024 · 1 comment
Open

Comments

@herzrasen
Copy link

The documentation for RepositoriesService.Create states that

Also note that this method will return the response without actually
waiting for GitHub to finish creating the repository and letting the
changes propagate throughout its servers. You may set up a loop with
exponential back-off to verify repository's creation.

However, doing so does not seem to be sufficient to ensure that a new repository has been synced.

I'm trying to create a new repository and enable Github Advanced Security features after it. The Update request returns a 200 and the result also indicates a success (the updated fields contain the value "enabled" which is what I wanted to achieve). When validating the result on github.com the features are disabled.
When I tried to sleep for a couple of seconds after creating and before updating the repo, the result is also visible on github.com.

Here is my code to reproduce the issue:

package main

import (
	"context"
	"fmt"
	"time"

	"github.com/google/go-github/v67/github"
	log "github.com/sirupsen/logrus"
)

func main() {
	org := "some-org"
	name := "some-repo"
	token := "some-token"

	client := github.NewClient(nil).WithAuthToken(token)
	_, _, err := client.Repositories.Create(context.Background(), org, &github.Repository{
		Name:          github.String(name),
		AutoInit:      github.Bool(true),
		Visibility:    github.String("internal"),
		DefaultBranch: github.String("main"),
	})
	if err != nil {
		log.WithError(err).Fatal("unable to create repository")
	}
	maxRetries := 5
	for i := 0; i < maxRetries; i++ {
		_, _, err := client.Repositories.Get(context.Background(), org, name)
		if err == nil {
			break
		}
		if i == maxRetries-1 {
			log.Fatal("unable to verify repository creation")
		}
		time.Sleep(time.Duration(i*2) * time.Second)
	}

	// time.Sleep(5 * time.Second)

	repo := github.Repository{
		SecurityAndAnalysis: &github.SecurityAndAnalysis{
			AdvancedSecurity: &github.AdvancedSecurity{
				Status: github.String("enabled"),
			},
			SecretScanning: &github.SecretScanning{
				Status: github.String("enabled"),
			},
		},
	}
	updatedRepo, _, err := client.Repositories.Edit(context.Background(), org, name, &repo)
	if err != nil {
		log.Fatal("unable to enable Advanced Security")
	}
	fmt.Printf("Advanced Security: %s\n", *updatedRepo.SecurityAndAnalysis.AdvancedSecurity.Status)
	fmt.Printf("Secret Scanning: %s\n", *updatedRepo.SecurityAndAnalysis.SecretScanning.Status)
}

No matter if I sleep the 5 seconds or not, both run print

Advanced Security: enabled
Secret Scanning: enabled

github.com without sleeping

Image

github.com with sleeping

Image

Any idea how I can make sure that the repository is ready to enable Advanced Security features? (I'm not sure if other updates are affected as well)

@gmlewis
Copy link
Collaborator

gmlewis commented Dec 4, 2024

Please contact GitHub official tech support with this question and feel free to report back here with their response.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants