arch-release-promotion 0.2.0

Openmetrics

If the upstream project offers an openmetrics based metrics file, the data from it can be used as additional information in the JSON payload.

The following metrics are considered.

# TYPE version_info info
# HELP version_info Package description and version information
version_info{name="my-package",description="Version of my-package used for build",version="1.0.0-1"} 1

"version_metrics": [
  {
    "name": "my-package",
    "description": "Version of my-package used for build",
    "version": "1.0.0-1"
  }
]

# TYPE artifact_bytes gauge
# HELP artifact_bytes Artifact sizes in Bytes
artifact_bytes{name="foo",description="Size of foo in MiB"} 832

"size_metrics": [
  {
    "name": "foo",
    "description": "Size of foo in MiB",
    "size": 832
  }
]

# TYPE data_count summary
# HELP data_count The amount of something used in some context
data_count{name="foo",description="The amount of packages in foo"} 369

"amount_metrics": [
  {
    "name": "foo",
    "description": "The amount of packages in foo",
    "amount": 369
  }
]

JSON payload

The promotion of a release encompasses one or more JSON payloads, that describe each release type in the release.

{
  "amount_metrics": [
    {
      "name": "foo",
      "description": "The amount of packages in foo",
      "size": 369
    }
  ],
  "developer": "Foobar McFooface <foobar@mcfooface.com>",
  "files": ["something.txt", "something.txt.sig"],
  "name": "foo",
  "pgp_public_key": "SOMEONESPGPKEYID",
  "size_metrics": [
    {
      "name": "foo",
      "description": "Size of foo in MiB",
      "size": 832
    }
  ],
  "torrent_file": "foo-0.1.0.torrent",
  "version_metrics": [
    {
      "name": "my-package",
      "description": "Version of my-package used for build",
      "version": "1.0.0-1"
    }
  ],
  "version": "0.1.0"
}

• amount_metrics: A list of objects that describe the amount of something (optional). The list depends on whether the project’s configuration defines amount_metrics and whether those metrics are available in the specific release.

• developer: The full uid of the person promoting (and optionally signing artifacts in) the release type.

• files: A list of files in the release type.

• name: The name of the release type.

• pgp_public_key: The PGP key ID of the key signing files in the release type.

• size_metrics: A list of objects that describe the size of something (optional). The list depends on whether the project’s configuration defines size_metrics and whether those metrics are available in the specific release.

• torrent_file (optional): The name of a torrent file created for the release type. The value depends on whether the configuration for the release type sets create_torrent to True.

• version_metrics: A list of objects that describe the version of something (optional). The list depends on whether the project’s configuration defines version_metrics and whether those metrics are available in the specific release.

• version: The version of the release type.

Location and cleanup

All release types for each release version are synchronized to a local directory. The directory and and the maximum amount of synchronized release versions are configurable globally or per project.

sync_dir
├── example_a
│   ├── example_a-0.1.0
│   │   ├── foo.txt
│   │   └── foo.txt.sig
│   ├── example_a-0.1.0.json
│   ├── example_a-0.1.0.torrent
│   └── latest -> example_a-0.1.0
└── example_b
    ├── example_b-0.1.0
    │   ├── bar.txt
    │   └── bar.txt.sig
    ├── example_b-0.1.0.json
    ├── example_b-0.1.0.torrent
    └── latest -> example_b-0.1.0

A latest symlink is created to point at the currently latest version of each release type.

Any files and directories that are not owned by versions of release types of the currently synchronized release versions are removed from the synchronization directory.

If changes are introduced to files in the target directory (due to a synchronization action), it is possible to write a Unix timestamp to a file that is configurable globally or per project (the directory in which the file resides in has to exist).