Improve local debug experience

Author: south-mer

config/policy-bot.example.yml

@@ -107,13 +107,23 @@ sessions:
 #   # POLICYBOT_OPTIONS_POLICY_PATH environment variable.
 #   policy_path: .policy.yml
 #
+#   # Force using a shared policy file from the organization repository
+#   # instead of the policy file in the repository. Can also be set by the
+#   # POLICYBOT_OPTIONS_FORCE_SHARED_POLICY environment variable.
+#   force_shared_policy: false
+#
 #   # The name of an organization repository to look in for a shared policy if
 #   # a repository does not define a policy file. Can also be set by the
 #   # POLICYBOT_OPTIONS_SHARED_REPOSITORY environment variable. Explicitly set
 #   # this or `shared_policy_path` to an empty string(`""`) to disable searching
 #   # in a shared repository.
 #   shared_repository: .github
 #
+#   # The branch in the shared organization repository to look in for a shared
+#   # policy file. Can also be set by the POLICYBOT_OPTIONS_SHARED_POLICY_BRANCH environment variable.
+#   # If not set, the default branch of the repository is used.
+#   shared_policy_branch: ""
+#
 #   # The path to the policy file in the shared organization repository.
 #   # Can also be set by the POLICYBOT_OPTIONS_SHARED_POLICY_PATH environment variable.
 #   shared_policy_path: policy.yml
@@ -122,6 +132,9 @@ sessions:
 #   # POLICYBOT_OPTIONS_STATUS_CHECK_CONTEXT environment variable.
 #   status_check_context: policy-bot
 #
+#   # If true, the bot removes the base branch from the status check context.
+#   status_check_context_ignore_base: true
+#
 #   # If true, expand teams, organizations, and permissions in the detils UI to
 #   # a list of users. This option has security implications; see the README.
 #   # Can also be set by the POLICYBOT_OPTIONS_EXPAND_REQUIRED_REVIEWERS
@@ -138,3 +151,9 @@ sessions:
 # files:
 #   static: build/static
 #   templates: server/templates
+
+# Options for OpenTelemetry tracing.
+#
+# opentelemetry:
+#   enabled: true
+#   google_cloud_support: true

server/handler/eval_options.go

@@ -40,8 +40,9 @@ type DescriptionPrefix struct {
 type PullEvaluationOptions struct {
 	PolicyPath string `yaml:"policy_path"`
 
-	SharedRepository *string `yaml:"shared_repository"`
-	SharedPolicyPath *string `yaml:"shared_policy_path"`
+	SharedRepository   *string `yaml:"shared_repository"`
+	SharedPolicyBranch *string `yaml:"shared_policy_branch"`
+	SharedPolicyPath   *string `yaml:"shared_policy_path"`
 
 	// Ignore PolicyPath and use SharedRepository and SharedPolicyPath only.
 	ForceSharedPolicy bool `yaml:"force_shared_policy"`

server/handler/fetcher.go

@@ -101,12 +101,18 @@ type ConfigFetcher struct {
 }
 
 func (cf *ConfigFetcher) configForSharedRepository(ctx context.Context, client *github.Client, owner string) (*FetchedConfig, error) {
-	r, _, err := client.Repositories.Get(ctx, owner, *cf.Options.SharedRepository)
-	if err != nil {
-		return nil, fmt.Errorf("failed to get repository %s/%s: %w", owner, *cf.Options.SharedRepository, err)
+	var ref string
+	if cf.Options.SharedPolicyBranch != nil {
+		ref = *cf.Options.SharedPolicyBranch
+	} else {
+		r, _, err := client.Repositories.Get(ctx, owner, *cf.Options.SharedRepository)
+		if err != nil {
+			return nil, fmt.Errorf("failed to get repository %s/%s: %w", owner, *cf.Options.SharedRepository, err)
+		}
+
+		ref = r.GetDefaultBranch()
 	}
 
-	ref := r.GetDefaultBranch()
 	file, _, _, err := client.Repositories.GetContents(ctx, owner, *cf.Options.SharedRepository, *cf.Options.SharedPolicyPath, &github.RepositoryContentGetOptions{
 		Ref: ref,
 	})