repository-settings.md 2.8 KB

Repository settings

This document describes any changes that have been made to the settings for this repository beyond the OpenTelemetry default repository settings.

General > Pull Requests

  • Allow squash merging > Default to pull request title

  • Allow auto-merge

Actions > General

  • Fork pull request workflows from outside collaborators: "Require approval for first-time contributors who are new to GitHub"

(To reduce friction for new contributors, as the default is "Require approval for first-time contributors")

Branch protections

The order of branch protection rules can be important. The branch protection rules below should be added before the **/** branch protection rule (this may require deleting the **/** rule and recreating it at the end).

main

  • Require branches to be up to date before merging: UNCHECKED

(PR jobs take too long, and leaving this unchecked has not been a significant problem)

  • Status checks that are required:

    • EasyCLA
    • required-status-check

release/*

Same settings as above for main.

cloudfoundry

Same settings as above for main, except for the required-status-check required status check.

renovate/**/** and opentelemetrybot/**/**

Same settings as for dependabot/**/**

gh-pages

  • Everything UNCHECKED

(This branch is currently only used for directly pushing benchmarking results from the Nightly overhead benchmark job)

Code security and analysis

  • Secret scanning: Enabled

Secrets and variables > Actions

  • GPG_PASSWORD - stored in OpenTelemetry-Java 1Password
  • GPG_PRIVATE_KEY - stored in OpenTelemetry-Java 1Password
  • GRADLE_ENTERPRISE_ACCESS_KEY - owned by @trask
  • GRADLE_PUBLISH_KEY
  • GRADLE_PUBLISH_SECRET
  • NVD_API_KEY - stored in OpenTelemetry-Java 1Password
  • OPENTELEMETRYBOT_GITHUB_TOKEN - owned by @trask
  • SONATYPE_KEY - owned by @trask
  • SONATYPE_USER - owned by @trask