Skip to content

chore: add tag-driven release workflow and community health files - #4

Merged
chen201724 merged 2 commits into
mainfrom
chore/release-engineering
Jul 24, 2026
Merged

chore: add tag-driven release workflow and community health files#4
chen201724 merged 2 commits into
mainfrom
chore/release-engineering

Conversation

@chen201724

Copy link
Copy Markdown
Member

Release engineering + community infrastructure:

  • Release workflow (release.yml): pushing a vX.Y.Z tag runs the full npm run check gate, verifies the tag matches package.json, publishes to npm with provenance, and creates the GitHub Release from the matching CHANGELOG section. Requires the NPM_TOKEN repo secret (npm automation token) — one-time setup.
  • CONTRIBUTING.md: dev setup, the unified check gate, the spec-driven workflow, layout conventions, and the maintainer release runbook.
  • SECURITY.md: private reporting via GitHub Security Advisories plus token-handling scope notes.
  • Issue/PR templates: bug report and feature request forms, contact links (security advisory, Yuque OpenAPI docs), and a PR checklist mirroring the repo's doc-sync rules.

No runtime code changes.

🤖 Generated with Claude Code

chen201724 and others added 2 commits July 24, 2026 12:59
- .github/workflows/release.yml: on vX.Y.Z tag push, run the full check
  gate, npm publish with provenance (NPM_TOKEN secret), and create the
  GitHub Release from the matching CHANGELOG section
- CONTRIBUTING.md: dev setup, check gate, spec-driven workflow, layout
  conventions, PR expectations, and the release runbook
- SECURITY.md: private reporting via GitHub Security Advisories, token
  handling scope notes
- Issue forms (bug/feature), issue config links, PR template

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: f44df0f59d

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +54 to +55
- name: Create GitHub Release from CHANGELOG
run: |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Move CHANGELOG validation before publishing

When a release tag has no matching nonempty ## X.Y.Z section—for example, because the version was bumped but the changelog was missed—this validation runs only after npm publish has permanently published that name/version. The job then exits without creating the GitHub Release, and rerunning stops at the already-published version; extract and validate the notes before publishing, and ideally make already-published reruns idempotent.

AGENTS.md reference: AGENTS.md:L89-L89

Useful? React with 👍 / 👎.

Comment thread SECURITY.md
Comment on lines +19 to +21
`YUQUE_TOKEN`, or `YUQUE_PERSONAL_TOKEN`. Tokens are only ever sent to the
configured Yuque host (`https://www.yuque.com` by default, or the host you
set via `--host` / `YUQUE_HOST`) as the `X-Auth-Token` header.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Avoid promising host-bound tokens while redirects remain enabled

When the configured API endpoint returns a cross-origin 3xx response, Axios follows it by default, while src/client/http.ts:38-46 sets X-Auth-Token globally without disabling redirects or stripping that custom header before redirecting. Consequently, the token can be forwarded beyond the configured host, contradicting this absolute security guarantee; either enforce same-origin redirects in the HTTP client or qualify the documentation.

Useful? React with 👍 / 👎.

@chen201724
chen201724 merged commit c828166 into main Jul 24, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant