Skip to content

Mark the package experimental, and bound what CI spends - #2

Open
liaowang11 wants to merge 2 commits into
mainfrom
chore/discoverability-and-ci
Open

liaowang11 wants to merge 2 commits into
mainfrom
chore/discoverability-and-ci

Conversation

@liaowang11

@liaowang11 liaowang11 commented Sep 6, 2026 •

Copy link
Copy Markdown
Owner

Three pieces of repository hygiene, none of which touch package behaviour.

Experimental notice

The README carries a GitHub alert saying command names, options, and the boundary instruction text can change without a deprecation period, that the package is not on MELPA, and that the live probes have run against one adapter only. It points at the existing sections that say what is and is not proven. The same warning, condensed to two lines, goes in the package Commentary, which is what M-x describe-package shows.

Discoverability

  • README gains a CI badge and a license badge, and an opening that names the terms someone would actually search: Emacs, AI coding session, Agent Client Protocol, session/fork, claude-agent-acp.
  • The Codex line now also places the package against Claude Code's /btw, and says how it differs: a real forked session that keeps its tools, rather than a single tool-less turn.
  • Repository description and 16 topics set through the API, following the convention upstream agent-shell uses.

CI

The workflow already ran the tests. What changed is what it is allowed to spend:

  • concurrency with cancel-in-progress on pull requests only. A burst of commits to a branch now costs one build instead of one per commit. Runs on main are left to finish, since they are the record that a given commit was green.
  • paths-ignore for **.md and LICENSE, so a documentation-only change starts no build.
  • timeout-minutes: 10, a stop for a hang rather than a target. The suite itself runs in under a second.
  • permissions: contents: read, since the job only reads the checkout.
  • Actions pinned to releases. actions/checkout@v4 was raising a Node 20 deprecation annotation on every run and is now @v7; purcell/setup-emacs@master is now @v8.0, since a branch moves under us and an action that changes without a version bump turns a green build into an unreproducible one.
  • The Emacs matrix stays at the single version Package-Requires names as the floor. Each entry added there is another full build per push.

Note that GitHub Actions is free and unmetered for public repositories, which this became today, so none of this is currently drawing on a quota. It matters for build latency, for tidiness, and if the repository ever goes private.

Verification

make check passes 78 tests on this branch, which is the count on main; PR #1 carries the other 14. The workflow YAML was parsed before committing. The one checkdoc warning on this branch is pre-existing on main and already fixed by PR #1.

Touches only regions PR #1 leaves alone, so the two merge in either order.

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