Hatch build plugin for source code metadata used by APM
Project description
hatch-datadog-build-metadata
CI/CD | |
Package | |
Meta |
This provides a plugin for Hatch that injects metadata from your preferred version control system like Git.
Table of Contents
Global dependency
Ensure hatch-datadog-build-metadata
is defined within the build-system.requires
field in your pyproject.toml
file.
[build-system]
requires = ["hatchling", "hatch-datadog-build-metadata"]
build-backend = "hatchling.build"
Metadata hook
Note: only Git is supported
The metadata hook plugin name is datadog-build-metadata
.
-
pyproject.toml
[tool.hatch.metadata.hooks.datadog-build-metadata]
Metadata hook options
URLs
The urls
option is equivalent to project.urls
except that each URL supports context formatting with the following fields:
commit_hash
- the latest commit hashremote_url
- the raw remote URL as stored in VCS configremote_http_url
- theremote_url
converted to an HTTP(S) URL
Be sure to add urls
to project.dynamic
:
-
pyproject.toml
[project] dynamic = [ "urls", ]
By default, the following URLs are set:
source_code_link
->{remote_http_url}#{commit_hash}
Example
The following example assumes that the code is hosted by GitHub.
-
pyproject.toml
[tool.hatch.metadata.hooks.datadog-build-metadata] Homepage = "https://www.example.com" source_archive = "{remote_http_url}/archive/{commit_hash}.tar.gz"
-
hatch.toml
[metadata.hooks.datadog-build-metadata] Homepage = "https://www.example.com" source_archive = "{remote_http_url}/archive/{commit_hash}.tar.gz"
License
hatch-datadog-build-metadata
is distributed under the terms of the MIT license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for hatch_datadog_build_metadata-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1d9e18f4351ef0fcef20ccda16befdcd6df3826b2bc95cf9411516ce3483a6b1 |
|
MD5 | 09f21da84a660a229a9cea81868056dd |
|
BLAKE2b-256 | 48efb9d3046fed954d022d82f9ca98f3c35f027d18e8060e3761715dbbaec381 |
Hashes for hatch_datadog_build_metadata-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1a1a0806e38d6de90bbde8ab1b0aa20a0323c1815c2cb7ea1e10ce4dbc0004f2 |
|
MD5 | 1bded42446f4853d47c39848e30db088 |
|
BLAKE2b-256 | ac9d0e6bd2d080f9daf0bac232f10cb0eea4d23217a0cad33e3406bb82e15e28 |