examples/example.toml:
Add a generic example file for project configuration that explains all
options.

README.rst:
As the openmetrics section is about how to configure openmetrics and
projects.toml to retrieve data from a build, it is best kept as a
subsection of the configuration section.

README.rst:
Move the "Use" section below "Requirements" section, as it was located
between sections that are dealing with configuration.

README.rst:
Update the JSON payload section to reflect the current settings around
metrics and how they are reflected in a JSON payload and update all
respective documentation around the payload's attributes.
Change the JSON payload section to become a subsection of the "Promotion
artifact" section.

README.rst:
Fix a typo in the Configuration section explaining that some of the
configuration options can also be passed in as environment variables.

README.rst:
Add section that explains the common files in a promotion artifact.

examples/projects.toml:
Change the releng example configuration to use all relevant metrics,
created by the releng releases and to create detached signatures for
relevant files per release type.

* origin/issues/4:
  gitlab-ci: Publish to pypi.org on tag

.gitlab-ci.yml:
Add a publish stage, that uses `poetry publish` on a secure runner to
push a release to pypi.org upon tagging. For this we make use of an
access token configured for the project via the environment variable
`POETRY_PYPI_TOKEN_PYPI`.

* origin/issues/5:
  cli: Change default program behavior to iterate over all projects
  argparse: Extend to show version and making project optional
  gitlab: Be explicit during release selection
  Remove hardcoded version string
  config: Raise when there are no project configurations

arch_release_promotion/cli.py:
Add `promote_project_release()` to promote releases of projects
generically. If no `release_version` is provided, user input is
requested to select a release that is not yet promoted.
Change `main()` to rely on `promote_project_release()` by either
promoting a specific release of a project (if the project or the project
and the release version are provided) or iterating over all available
projects in the configuration to allow the user to promote releases for
them.

arch_release_promotion/argparse.py:
Change `ArgParseFactory.__init__()` to allow overriding the program name
add a `-V`/`--version` argument which may be used to trigger showing the
version of the program.
Change `ArgParseFactory.promote()` to replace the required `name`
argument with the optional `-p`/`--project` argument and adding an
optional `-r`/`--release` argument which may be used to override the
release version to promote. Print program name and version information
and exit early if version information is requested.

tests/test_argparse.py:
Change tests to accomodate for the new optional arguments.

arch_release_promotion/cli.py:
Replace the use of `args.name` with `args.project`.

arch_release_promotion/gitlab.py:
Change `Upstream.select_release()` to also show the name of the project
for which the selection of the release is done.

arch_release_promotion/__init__.py:
Remove the hardcoded `__version__` string.
We want to rely on importlib metadata in the future.

arch_release_promotion/config.py:
Raise RuntimeError if there are no configuration files to be read.

tests/test_config.py:
Adapt tests for the case where there are no configuration files
supplied.

* issues/11:
  Add documentation on openmetrics
  examples: Change according to new metrics behavior
  Read openmetrics of different types

README.rst:
Add a section on how and which types of openmetrics are considered to
collect version, size, or amount information from a metrics file.
Change the JSON payload according to the more diverse set of understood
openmetrics.

examples/projects.toml:
Change the example configuration to make use of `version_metrics`
instead of `info_metrics`.

arch_release_promotion/release.py:
Add `Metric`, `SizeMetric`, `AmountMetric` and |VersionMetric| models,
that track metrics with size, amount or version (respectively).
Change the `Release` model to use `amount_metrics`, `size_metrics` and
`version_metrics` attributes instead of `info`.

arch_release_promotion/config.py:
Change the `ReleaseConfig` model to track `version_metrics`,
`size_metrics` and `amount_metrics` instead of `info_metrics`.

arch_release_promotion/files.py:
Change `read_metrics_file()` to return a tuple of AmountMetric,
SizeMetric and VersionMetric lists and read the provided file only if it
exists.

arch_release_promotion/cli.py:
Change `main()` to correctly initialize instances of `Release` with the
different types of metrics.

tests/*:
Change the tests to match the changes in signature and attributes.

* issues/3:
  Add tests target against system packages
  tox: Remove unneeded environment variable
  Validate PRIVATE_TOKEN in config

.gitlab-ci.yml:
Add a test target against system packages.

tox.ini:
Remove unneeded PRIVATE_TOKEN environment variable, as the parametrized
tests for config.Settings take care of testing the attribute properly.

arch_release_promotion/config.py:
Add `Settings.validate_private_token()` to validate the PRIVATE_TOKEN
attribute.

tests/test_config.py:
Change the `test_settings()` parametrization to also check for the
validity of a PRIVATE_TOKEN.

* issues/6:
  Iteratively attempt to sign files

arch_release_promotion/signature.py:
Add `sign_file()` to sign a single file and return the status code of
the gpg call.
Change `sign_files_in_dir()` to call `sign_file()` iteratively per file
until a status code of 0 is emitted.

tests/test_signature.py:
Add tests for `sign_file()` and adapt tests for the changes to
`sign_files_in_dir()`.

* issues/1:
  Add payload documentation to README
  Add create_torrent to example
  Create torrent file conditionally

README.rst:
Expand introduction section to explain that the release of a project may
contain several release types and that promotion is done per release
type.
Add documentation on the JSON payload and its different attributes.

examples/projects.toml:
Add the create_torrent option to the bootstrap and iso releases.

arch_release_promotion/config.py:
Add an additional `create_torrent` bool attribute to ReleaseConfig, that
defaults to False.

arch_release_promotion/release.py:
Change the `torrent_file` attribute of Release to be optional.

arch_release_promotion/torrent.py:
Change `create_torrent_file()` to return the name of the created torrent
file.

arch_release_promotion/cli.py:
Change `main()` to conditionally create the torrent file and attach it
to the release information.

* initial:
  Add gitlab CI integration
  Add a poetry lock file
  Remove initial README
  Add simple CLI entry_point
  Add example projects.toml
  Add tox integration
  Add argparse integration
  Add integration for PGP signatures
  Add model to describe per release information
  Add configuration layer
  Add gitlab integration
  Add layer for file operations
  Add integration for torrent creation
  Initialize modules
  Add .gitignore file
  Add flake8 configuration
  Add pyproject.toml
  Add editorconfig configuration file
  Add basic README.rst
  Add GPL-3.0 license file

.gitlab-ci.yml:
Add gitlab CI integration to run linter and coverage targets.

poetry.lock:
Add a poetry.lock file to have reproducible testing.

README.md:
The initial README is superseded by README.rst.

arch_release_promotion/cli.py:
Add a simple (yet currently rather convoluted) entry_point to run the
arch-release-promotion script.

examples/projects.toml:
Add an example projects.toml which describes the configuration for
https://gitlab.archlinux.org/archlinux/releng.

tox.ini:
Add simple tox integration for a linter and a coverage target.

arch_release_promotion/argparse.py:
Add a generic and testable argparse integration.

tests/test_argparse.py:
Add tests for argparse integration.

arch_release_promotion/signature.py:
Add basic integration to create PGP signatures for files in a directory.

tests/test_signature.py:
Add tests for creating signatures.

arch_release_promotion/release.py:
Add a pydantic model to generically describe release artifact
information.

tests/test_release.py:
Add basic tests for release model.

arch_release_promotion/config.py:
Add pydantic based configuration layer that allows to read
packager/signer information from an existing makepkg configuration and
project specific information from TOML files in XDG config home
compatible locations.

tests/test_config.py:
Add tests for the various configuration classes and models.