ATathenian
settings
default

👤 Set the release matching rule for a list of repositories. Only for account admins. Release settings are rules by which to mark releases in GitHub repositories.

put/settings/release_match

Request

Request body

accountinteger required

Account ID.

repositoriesRepositoryID[] required

Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored.

branchesstring

Regular expression to match branch names. The match starts from the beginning of the string. Special value {{ "{{default}}" }} matches to the default branch name - usually, main or master. Reference: https://www.postgresql.org/docs/current/functions-matching.html#FUNCTIONS-SIMILARTO-REGEXP

tagsstring

Regular expression to match tag names. The match starts from the beginning of the string. Reference: https://www.postgresql.org/docs/current/functions-matching.html#FUNCTIONS-SIMILARTO-REGEXP

eventsstring

Regular expression to match event releases (submitted by the user via /events/releases). The match starts from the beginning of the string. Reference: https://www.postgresql.org/docs/current/functions-matching.html#FUNCTIONS-SIMILARTO-REGEXP

match'branch' | 'event' | 'tag' | 'tag_or_branch' required

Release workflow choice: how we should detect releases.

  • branch: merges to certain branches are considered releases and nothing else.
  • event: releases are manually registered with POST /events/releases.
  • tag: tags with certain name patterns are considered releases and nothing else.
  • tag_or_branch: follow "tag"; if the repository does not have tags, fallback to "branch".

Example request

{
  "account": 1,
  "repositories": [
    "github.com/athenianco/athenian-webapp",
    "github.com/athenianco/athenian-api"
  ],
  "match": "branch",
  "branches": "master",
  "tags": ".*"
}

Response

List the repositories affected.

RepositoryID[] required

Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored.

Example response

[
  "github.com/athenianco/athenian-webapp",
  "github.com/athenianco/athenian-api"
]

Changes

No recorded changes to this operation across all 70 revisions of this API.