Configuration

RegistryConfiguration

Shared configuration fields used by both PR checking and merging functionality.

RegistryConfiguration(; kwargs...)
RegistryConfiguration(config::RegistryConfiguration; kwargs...)  # Override constructor

The second form creates a config with specified fields overridden, e.g., RegistryConfiguration(config; read_only=true).

Required keyword arguments (& fields)

• registry::String: the registry name you want to run AutoMerge on.
• authorized_authors::Vector{String}: list of who can submit registration, e.g String["JuliaRegistrator"].
• authorized_authors_special_jll_exceptions::Vector{String}: a list of users who can submit JLL packages (which have strict rules about allowed dependencies and are subject to new_jll_*_waiting_minutess instead of new_*_waiting_minutess).
• new_package_waiting_minutes::Dates.Minute: new package waiting period in minutes.
• new_jll_package_waiting_minutes::Dates.Minute: new JLL package waiting period in minutes.
• new_version_waiting_minutes::Dates.Minute: new package version waiting period in minutes.
• new_jll_version_waiting_minutes::Dates.Minute: new JLL package version waiting period in minutes.

Keyword arguments (& fields) with default values

• master_branch::String = "master": name of master_branch, e.g you may want to specify this to "main" for new GitHub repositories.
• error_exit_if_automerge_not_applicable::Bool = false: if false, AutoMerge will not error on PRs made by non-AutoMerge-authorized users
• api_url::String = "https://api.github.com": the registry host API URL.
• read_only::Bool = false: run in read only mode.

CheckPRConfiguration

Configuration struct for checking PR registration validity (security-isolated functionality).

CheckPRConfiguration(; kwargs...)
CheckPRConfiguration(config::CheckPRConfiguration; kwargs...)  # Override constructor

The second form creates a config with specified fields overridden, e.g., CheckPRConfiguration(config; check_license=false).

Keyword arguments (& fields) with default values

• master_branch_is_default_branch::Bool = true: if master_branch specified above is the default branch.
• suggest_onepointzero::Bool = true: should the AutoMerge comment include a suggestion to tag a 1.0 release for v0.x.y packages.
• point_to_slack::Bool = false: should the AutoMerge comment recommend sending a message to the #pkg-registration Julia-Slack channel when auto-merging is not possible.
• registry_deps::Vector{String} = String[]: list of registry dependencies, e.g your packages may depend on General.
• check_license::Bool = false: check package has a valid license.
• check_breaking_explanation::Bool = false: Check whether the PR has release notes (collected via Registrator.jl) with a breaking change explanation.
• public_registries::Vector{String} = String[]: If a new package registration has a UUID that matches that of a package already registered in one of these registries supplied here (and has either a different name or different URL) then an error will be thrown. This to prevent AutoMerge from being used for "dependency confusion" attacks on those registries.
• environment_variables_to_pass::Vector{String} = String[]: Environment variables to pass to the subprocess that does Pkg.add("Foo") and import Foo
• commit_status_token_name::String = "AUTOMERGE_GITHUB_TOKEN": Name of the environment variable containing the GitHub token used for PR validation. The token stored in this environment variable needs repo:status permission to set commit statuses and read access to PRs, but does not need write access to the repository.

MergePRsConfiguration

Configuration struct for merging approved PRs (requires merge permissions).

MergePRsConfiguration(; kwargs...)
MergePRsConfiguration(config::MergePRsConfiguration; kwargs...)  # Override constructor

The second form creates a config with specified fields overridden, e.g., MergePRsConfiguration(config; merge_new_packages=false).

Keyword arguments (& fields) with default values

• merge_new_packages::Bool = true: should AutoMerge merge registration PRs for new packages
• merge_new_versions::Bool = true: should AutoMerge merge registration PRs for new versions of packages
• additional_statuses::Vector{String} = String[]: list of additional commit statuses that must pass before AutoMerge will merge a PR
• additional_check_runs::Vector{String} = String[]: list of additional check runs that must pass before AutoMerge will merge a PR
• merge_token_name::String = "AUTOMERGE_MERGE_TOKEN": Name of the environment variable containing the GitHub token used for PR merging. The token stored in this environment variable needs write access to the repository to merge PRs.

AutoMergeConfiguration

Combined configuration object containing registry, PR checking, and PR merging settings.

AutoMergeConfiguration(; registry_config, check_pr_config, merge_prs_config)
AutoMergeConfiguration(config::AutoMergeConfiguration; kwargs...)  # Override constructor

The second form creates a config with specified sub-configs overridden, e.g., AutoMergeConfiguration(config; registry_config=new_reg_config).

Keyword arguments & fields

• registry_config::RegistryConfiguration: Shared registry settings
• check_pr_config::CheckPRConfiguration: PR validation settings
• merge_prs_config::MergePRsConfiguration: PR merging settings

AutoMerge.general_registry_config()

This is the AutoMerge.AutoMergeConfiguration object containing shared configuration for the General registry. This configuration is used by both PR checking and merging functionality.

Here are the settings chosen for General in this version of AutoMerge.jl:

julia> AutoMerge.general_registry_config()
AutoMerge.AutoMergeConfiguration with:
  registry_config:
    registry: `"JuliaRegistries/General"`
    authorized_authors: `["JuliaRegistrator"]`
    authorized_authors_special_jll_exceptions: `["jlbuild"]`
    new_package_waiting_minutes: `Dates.Minute(4320)`
    new_jll_package_waiting_minutes: `Dates.Minute(20)`
    new_version_waiting_minutes: `Dates.Minute(10)`
    new_jll_version_waiting_minutes: `Dates.Minute(10)`
    master_branch: `"master"`
    error_exit_if_automerge_not_applicable: `false`
    api_url: `"https://api.github.com"`
    read_only: `false`
  check_pr_config:
    master_branch_is_default_branch: `true`
    suggest_onepointzero: `false`
    point_to_slack: `true`
    registry_deps: `String[]`
    check_license: `true`
    check_breaking_explanation: `true`
    public_registries: `["https://github.com/HolyLab/HolyLabRegistry", "https://github.com/cossio/CossioJuliaRegistry"]`
    environment_variables_to_pass: `String[]`
    commit_status_token_name: `"AUTOMERGE_GITHUB_TOKEN"`
  merge_prs_config:
    merge_new_packages: `true`
    merge_new_versions: `true`
    additional_statuses: `String[]`
    additional_check_runs: `String[]`
    merge_token_name: `"AUTOMERGE_MERGE_TOKEN"`

read_config(path) -> AutoMergeConfiguration

Read an AutoMerge configuration from a TOML file.

write_config(path, config::AbstractConfiguration) -> Nothing

Write an AutoMerge configuration to a TOML file. Automatically handles serialization of Dates.Minute fields to integer values.