docs: add DEVELOPMENT.md, CONTRIBUTING.md, and AGENTS.md#126
Merged
Conversation
Add contributor-facing documentation explaining the generation framework (Task as source of truth, derived StepAction), local testing, and the release process. - DEVELOPMENT.md: architecture, StepAction derivation, image build, testing, and release flow - CONTRIBUTING.md: DCO/CLA, PR workflow, CI expectations - AGENTS.md: repo structure, critical invariants, common commands Link the new docs from README.md. Closes #125 Signed-off-by: Vincent Demeester <vdemeest@redhat.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
tekton-robot
added
the
size/L
There was a problem hiding this comment.
Pull request overview
Adds contributor-facing documentation for the tektoncd-catalog/git-clone repo, describing how the Task → StepAction generation workflow works, how to test locally/CI, and how releases are performed. This helps new contributors (and AI agents) make correct changes without breaking the generator invariants.
Changes:
- Add
DEVELOPMENT.mddocumenting repo architecture, generation, testing, and the release flow. - Add
CONTRIBUTING.mddocumenting contribution workflow (DCO/EasyCLA, conventional commits) and CI expectations. - Add
AGENTS.mdwith a concise “rules + commands + pitfalls” reference for AI coding agents, and link all docs fromREADME.md.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| README.md | Adds links to the new contributor/agent documentation. |
| DEVELOPMENT.md | New developer guide covering generation, testing, and release process. |
| CONTRIBUTING.md | New contribution and CI expectations guide. |
| AGENTS.md | New quick-reference for AI agents, repo invariants, and common commands/pitfalls. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```bash | ||
| kind create cluster | ||
|
|
||
| # Task: install it and run every TaskRun in tests/run.yaml |
Comment on lines
+53
to
+55
| - **E2E matrix** — installs the Task in a kind cluster and runs the TaskRuns in | ||
| `tests/run.yaml` across the supported Tekton Pipelines versions, plus the | ||
| bundle e2e test. |
| | `hack/release.sh` | Release automation: bump version → regenerate → changelog → commit → tag → push. | | ||
| | `hack/apply-ah-changes.py` | Injects the `artifacthub.io/changes` annotation during release. | | ||
| | `test/` | e2e runners (`e2e-tests.sh`, `e2e-bundle-test.sh`). | | ||
| | `keys/` | `cosign.pub` (bundle verification) and signing material. | |
| | `hack/release.sh` | Release automation. | | ||
| | `hack/apply-ah-changes.py` | Injects the `artifacthub.io/changes` annotation at release. | | ||
| | `test/` | e2e runners (`e2e-tests.sh`, `e2e-bundle-test.sh`). | | ||
| | `keys/` | `cosign.pub` and signing material. | |
- Clarify keys/ contains only the committed cosign.pub public key (the signing-key.pem is gitignored), not generic 'signing material'. - Reference the actual TaskRun manifest paths (task/git-clone/tests/run.yaml and stepaction/git-clone/tests/run.yaml) instead of the imprecise 'tests/run.yaml'. Signed-off-by: Vincent Demeester <vdemeest@redhat.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds contributor-facing documentation explaining the repo's generation framework, testing, and release process. Closes #125.
Follows the same pattern as tektoncd-catalog/golang#31, adapted to git-clone's actual structure (the
git-cloneTask is the source of truth, and the StepAction is derived from it viahack/generate-stepaction.py— git-clone does not use thebase/+catalog.yamlmodel).Files
DEVELOPMENT.md— architecture overview (Task → StepAction derivation), how generation works, modifying the Task/StepAction, building thegit-initimage, running unit + e2e tests, and therelease.shflow.CONTRIBUTING.md— DCO/EasyCLA sign-off, PR workflow, conventional commits, and CI expectations (Build & Test, Verify StepAction is in sync, e2e matrix).AGENTS.md— repo structure, critical invariants (never editstepaction/directly, no$(params.*)in scripts, workspace→param mapping), common commands, and common pitfalls.README.md— links to the new docs.Notes
All content was derived from the actual
hack/scripts and.github/workflows/, including the Trusted Resources signing caveat (blocked by tektoncd/cli#2894 / #2895; bundle + image are cosign-signed in the release workflow instead).