Skip to content

Commit 7023c7b

Browse files
author
cncf-automation[bot]
committed
Initial .project scaffold for Apicurio Registry
0 parents  commit 7023c7b

7 files changed

Lines changed: 192 additions & 0 deletions

File tree

‎.github/workflows/update-landscape.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Update Landscape
2+
on:
3+
push:
4+
branches: [main]
5+
paths:
6+
- 'project.yaml'
7+
workflow_dispatch:
8+
9+
jobs:
10+
update:
11+
runs-on: ubuntu-latest
12+
permissions:
13+
contents: write
14+
pull-requests: write
15+
steps:
16+
- name: Checkout
17+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v4
18+
with:
19+
fetch-depth: 0
20+
21+
- name: Update Landscape
22+
uses: cncf/automation/.github/actions/landscape-update@95d25b12337a14e4a74f690c856f6903584e839e
23+
with:
24+
project_file: 'project.yaml'
25+
token: ${{ secrets.LANDSCAPE_REPO_TOKEN }}

‎.github/workflows/validate.yaml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Validate Project Metadata
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- 'project.yaml'
7+
- 'maintainers.yaml'
8+
push:
9+
branches: [main]
10+
paths:
11+
- 'project.yaml'
12+
- 'maintainers.yaml'
13+
workflow_dispatch:
14+
15+
jobs:
16+
validate-project:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v4
20+
with:
21+
fetch-depth: 0
22+
23+
- uses: cncf/automation/.github/actions/validate-project@95d25b12337a14e4a74f690c856f6903584e839e
24+
with:
25+
project_file: 'project.yaml'
26+
27+
validate-maintainers:
28+
runs-on: ubuntu-latest
29+
steps:
30+
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v4
31+
with:
32+
fetch-depth: 0
33+
34+
- uses: cncf/automation/.github/actions/validate-maintainers@95d25b12337a14e4a74f690c856f6903584e839e
35+
with:
36+
maintainers_file: 'maintainers.yaml'
37+
verify_maintainers: 'true'
38+
env:
39+
LFX_AUTH_TOKEN: ${{ secrets.LFX_AUTH_TOKEN }}

‎.gitignore‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.cache/
2+
.DS_Store
3+
Thumbs.db
4+
.idea/
5+
.vscode/
6+
*~
7+
*.swp

‎CODEOWNERS‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# CODEOWNERS for .project metadata repository
2+
# Changes to project metadata require maintainer review.
3+
# TODO: Add CODEOWNERS
4+
# * @maintainer-handle

‎README.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Apicurio Registry `.project`
2+
3+
`.project` (dot-project) is a CNCF initiative to centralize and automate metadata management for all CNCF projects.
4+
This repository holds the canonical metadata for [Apicurio Registry](https://www.apicur.io) and is maintained by the CNCF automation tooling.
5+
6+
## What's in this repo
7+
8+
| File | Purpose |
9+
|------|---------|
10+
| `project.yaml` | Canonical project metadata (name, maturity, repositories, governance links, …) |
11+
| `maintainers.yaml` | Maintainer and reviewer roster used for drift detection and mailing-list sync |
12+
| `CODEOWNERS` | Ensures PRs to this repo require maintainer approval |
13+
| `.github/workflows/validate.yaml` | CI — validates `project.yaml` and `maintainers.yaml` on every PR |
14+
| `.github/workflows/update-landscape.yml` | Automatically proposes landscape updates when `project.yaml` changes |
15+
16+
## Keeping metadata up to date
17+
18+
Open a pull request against this repository to update any metadata field.
19+
The validate workflow will check schema correctness and block merge if validation fails.
20+
21+
> **Note:** This repository was bootstrapped automatically from public sources (CNCF landscape, CLOMonitor, GitHub governance files).
22+
> Some fields are best-effort guesses marked with `# TODO: AUTO-DETECTED — please verify` in the YAML files and should be confirmed by the project maintainers.
23+
24+
## Resources
25+
26+
- [`.project` documentation](https://github.com/cncf/automation/tree/main/utilities/dot-project)
27+
- [Schema reference](https://github.com/cncf/automation/blob/main/utilities/dot-project/SCHEMA.md)
28+
- [CNCF Automation repository](https://github.com/cncf/automation)

‎maintainers.yaml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Maintainer roster for Apicurio Registry
2+
# Documentation: https://github.com/cncf/automation/tree/main/utilities/dot-project
3+
4+
# TODO: Add maintainer GitHub handles
5+
6+
# Maintainers: Please connect your GitHub handle to your LFID on openprofile.dev to enable automatic access to CNCF resources. The system will use your primary email address for setup.
7+
maintainers:
8+
- project_id: "apicurio-registry"
9+
org: "Apicurio"
10+
teams:
11+
- name: "project-maintainers"
12+
members:
13+
# TODO: Add maintainer handles
14+
- github-handle

‎project.yaml‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# .project metadata for Apicurio Registry
2+
# Documentation: https://github.com/cncf/automation/tree/main/utilities/dot-project
3+
4+
# TODO: Set project_lead GitHub handle
5+
# TODO: Set slack_channels
6+
# TODO: Set identity_type under legal (has_dco, has_cla)
7+
# TODO: Add package_managers if distributed via registries
8+
# TODO: No maintainers found in cncf/foundation project-maintainers.csv — add maintainer handles manually
9+
10+
schema_version: "1.0.0"
11+
slug: "apicurio-registry"
12+
name: "Apicurio Registry"
13+
description: "Apicurio Registry is a runtime server system that stores a specific set of artifacts as files. "
14+
type: "project"
15+
# TODO: Set project lead GitHub handle
16+
# project_lead: "github-handle"
17+
# TODO: Set CNCF Slack channel(s)
18+
# slack_channels:
19+
# - name: "#apicurio-registry"
20+
# primary: true
21+
22+
maturity_log:
23+
- phase: "sandbox"
24+
date: "2026-03-12T00:00:00Z"
25+
issue: "https://github.com/cncf/sandbox/issues/495" # TODO: AUTO-DETECTED — please verify
26+
27+
repositories:
28+
- "https://github.com/Apicurio/apicurio-registry"
29+
30+
website: "https://www.apicur.io"
31+
32+
artwork: "https://landscape.cncf.io/logos/apicurio-registry.svg"
33+
34+
adopters:
35+
path: "https://github.com/Apicurio/apicurio-registry/blob/main/ADOPTERS.md"
36+
37+
38+
# TODO: Add package manager identifiers if your project is distributed via registries
39+
# package_managers:
40+
# docker: "Apicurio/apicurio-registry"
41+
42+
social:
43+
twitter: "https://twitter.com/apicurio"
44+
45+
security:
46+
policy:
47+
path: "https://github.com/Apicurio/apicurio-registry/blob/main/SECURITY.md"
48+
contact:
49+
advisory_url: "https://github.com/Apicurio/apicurio-registry/security/advisories/new"
50+
51+
governance:
52+
contributing:
53+
path: "https://github.com/Apicurio/apicurio-registry/blob/main/CONTRIBUTING.md"
54+
code_of_conduct:
55+
path: "https://github.com/Apicurio/apicurio-registry/blob/main/CODE_OF_CONDUCT.md"
56+
57+
legal:
58+
license:
59+
path: "https://github.com/Apicurio/apicurio-registry/blob/main/LICENSE"
60+
identity_type:
61+
has_dco: true
62+
has_cla: false
63+
dco_url:
64+
path: "https://developercertificate.org/"
65+
66+
documentation:
67+
readme:
68+
path: "https://github.com/Apicurio/apicurio-registry/blob/main/README.md"
69+
70+
landscape:
71+
category: "App Definition and Development"
72+
subcategory: "Streaming & Messaging"
73+
74+
# CLOMonitor Score: 69/100
75+
# Documentation: 88 | License: 86 | Best Practices: 16 | Security: 68

0 commit comments

Comments
 (0)