Skip to contents

Published cross-port contract of this sitemapr build

Source: R/contract-version.R
sitemap_contract.Rd

Returns the contract identity that sibling implementations pin against (ADR-009 §7): which findings-contract generation this build speaks, which revision of the finding-code registry it ships, the per-ruleset revisions, and the sibling-package version ranges it is known to work with.

Usage

sitemap_contract()

Value

A named list:

contract_id

Length-1 character. Stable identifier for the findings-contract generation, e.g. "sitemapr.findings/v2".

contract_version

Length-1 character. The generation number.

legacy_contract_version

Length-1 character. The older generation still accepted by consumers.

registry_revision

Length-1 character. Date-stamped revision of findings-registry.csv.

ruleset_revisions

Named character. Per-ruleset revisions; the same values ruleset_revision() returns one at a time.

sibling_versions

Named character. Supported version range per sibling package.

Details

The sibling_versions map has the same shape as robotstxtr's robots_engine_contract_v1()$sibling_versions and sitemap-validator's SIBLING_VERSIONS, so all three repos in the contract publish their ranges identically.

See also

ruleset_revision() for a single ruleset's revision.

Examples

sitemap_contract()$sibling_versions
#>   sitemap-validator          robotstxtr 
#> ">= 1.0.0, < 2.0.0" ">= 0.2.0, < 0.3.0"