Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
d5b0454
Restructure repository: reorganize spec, add tests, governance docs, …
Ma11hewThomas Jan 24, 2026
a15d3d1
Clarify usage of `extra` object in CTRF specification
Ma11hewThomas Jan 24, 2026
e43c0d9
Add support section to README with encouragement to star the repository
Ma11hewThomas Jan 24, 2026
b518992
Fix link text for the Roadmap in README
Ma11hewThomas Jan 24, 2026
74a5305
Update workflow to trigger on all branches for push and pull requests
Ma11hewThomas Jan 24, 2026
0aa4f9d
Add blank line for improved readability in workflow file
Ma11hewThomas Jan 24, 2026
c9b1bf2
Update workflow files to use specific version of sourcemeta/jsonschem…
Ma11hewThomas Jan 24, 2026
38cf31e
Fix versioning for informative tests in workflow file
Ma11hewThomas Jan 24, 2026
ef79d18
Refactor test workflow to streamline jsonschema usage and improve cla…
Ma11hewThomas Jan 24, 2026
f669fae
Add github-report option to test result publishing steps for clarity
Ma11hewThomas Jan 24, 2026
74f07fb
Rename workflow from "Test" to "Validate Schema" for improved clarity
Ma11hewThomas Jan 24, 2026
78ac2b0
Refactor workflow files to streamline jsonschema usage and enhance cl…
Ma11hewThomas Jan 24, 2026
99378c1
Enhance schema validation process by adding linting step and updating…
Ma11hewThomas Jan 24, 2026
157c93c
Update README and schema files for clarity and consistency in descrip…
Ma11hewThomas Jan 24, 2026
e0c16d9
Update CODE_OF_CONDUCT.md
Ma11hewThomas Jan 24, 2026
4445ae5
Update CONTRIBUTING.md to clarify process for breaking changes
Ma11hewThomas Jan 24, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 74 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
name: Release

on:
push:
tags:
- 'v*.*.*'

permissions:
contents: write

jobs:
test:
name: Validate Schema
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Setup jsonschema
uses: sourcemeta/jsonschema@v14.4.0

- name: Run conformance tests (normative)
run: jsonschema test tests/normative --json > ctrf-normative.json

- name: Run informative tests
run: jsonschema test tests/informative --json > ctrf-informative.json
continue-on-error: true

- name: Validate example documents
run: jsonschema validate schema/ctrf.schema.json examples/*.json

- name: Publish Conformance Test Results
uses: ctrf-io/github-test-reporter@v1
if: always()
with:
report-path: ctrf-normative.json
github-report: true

- name: Publish Informative Test Results
uses: ctrf-io/github-test-reporter@v1
if: always()
with:
report-path: ctrf-informative.json
github-report: true

release:
name: Create Release
runs-on: ubuntu-latest
needs: test

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Extract version from tag
id: version
run: echo "version=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT

- name: Create GitHub Release
uses: softprops/action-gh-release@v2
with:
name: CTRF ${{ steps.version.outputs.version }}
draft: true
make_latest: true
generate_release_notes: true
files: |
schema/ctrf.schema.json
spec/ctrf.md
examples/*.json
CHANGELOG.md
LICENSE
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
50 changes: 50 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Validate Schema

on:
push:
branches: ['**']

pull_request:
branches: ['**']

jobs:
test:
name: Validate Schema
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Setup jsonschema
uses: sourcemeta/jsonschema@v14.4.0

- name: Run format validation
run: jsonschema fmt schema/ctrf.schema.json --check

- name: Run schema linting
run: jsonschema lint schema/ctrf.schema.json --exclude top_level_examples

- name: Run conformance tests (normative)
run: jsonschema test tests/normative --json > ctrf-normative.json

- name: Run informative tests
run: jsonschema test tests/informative --json > ctrf-informative.json
continue-on-error: true

- name: Validate example documents
run: jsonschema validate schema/ctrf.schema.json examples/*.json

- name: Publish Conformance Test Results
uses: ctrf-io/github-test-reporter@v1
if: always()
with:
report-path: ctrf-normative.json
github-report: true

- name: Publish Informative Test Results
uses: ctrf-io/github-test-reporter@v1
if: always()
with:
report-path: ctrf-informative.json
github-report: true
3 changes: 0 additions & 3 deletions .gitignore

This file was deleted.

8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
119 changes: 119 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
Matthew Poulton-White.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Loading
Loading