eric/ReleaseKit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Complete module release documentation

Browse Source
This commit is contained in:
Eric Rakestraw
2026-10-10 04:03:42 +00:00
parent b49c1f379e
commit 90559fe01b
18 changed files with 260 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/integrations/gitea.md
View File

@@ -13,10 +13,19 @@ the `Authorization: token …` request header and is not included in errors or
results. The base URL must use HTTP or HTTPS and cannot contain URL credentials,
a query, or a fragment.
The selected module derives a complete tag from its semantic version and
physical repository-relative directory. For example, version `v1.2.3` in
`integrations/ckconfig` uses `integrations/ckconfig/v1.2.3`; a root module uses
`v1.2.3`. The client first reads
The selected module derives a complete tag from its semantic version, declared
module path, and physical repository-relative directory. For example, version
`v1.2.3` in `integrations/ckconfig` uses
`integrations/ckconfig/v1.2.3`; a root module uses `v1.2.3`. A `/v2` module
stored at `integrations/core/v2` uses `integrations/core/v2.1.0`; the same
declared module stored at `integrations/core` derives the same tag. ReleaseKit
removes a final physical `/v2` directory from the tag prefix only when the
module declaration has that `/v2` suffix. A module-local note stays at
`<module>/docs/releases/<version>.md`, including a physical `/v2` directory.
Shared license files remain at the repository root. Use the complete derived
tag as the immutable source ref in note links, with paths rooted at the
repository; license footer links target the root `COPYRIGHT`, `LICENSE`, and
`docs/oss/attribution.md` files. The client first reads
`/api/v1/repos/{owner}/{repo}/tags/{tag}` and requires the hosted tag's commit
SHA to equal the captured source commit. It then reads
`/api/v1/repos/{owner}/{repo}/releases/tags/{tag}`. A matching existing page