Skip to content

Document and refine purl-spec repo CI workflows #832

@mjherzog

Description

@mjherzog

The current CI workflow for the purl-spec repo/project is based on an early implementation from the initial creation of the current repo structure in July 2025 (converted from narrative documentation into schemas, test file and new documentation artifacts).

The subject of this issue is to:

  • Document the current CI workflow files
  • Upgrade the "developer" documentation in the README-dev.md files with details about what the workflows do, how and why. The future home for this file will probably be /etc/ or /etc/scripts folder as internal documentation
  • Upgrade/refine the workflows as needed
  • Complete CONTRIBUTING.md documentation. This is the "natural" home for information about how a contributor should set up their local environment and create PRs. README.dev.md - see also:

The objectives are to:

  • Ensure consistent validation of changes to purl-spec artifacts - these are primarily documentation files, schema files and test case files
  • Improve the purl-spec contributor experience

The primary use cases for the CI workflows are to check/validate:

It probably makes sense to run the full validation check for any PR rather than try to detect which checks to run because the validation should be very fast.

Metadata

Metadata

Assignees

Type

Projects

Status

awaiting feedback

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions