agentleFS
rjdelleceserjdellecese/confect/.agents/skills/release-docs/SKILL.md

release-docs

Skill381 starsChanged 8 days agoISCView on GitHub

Deploy the current documentation from a specified main commit without publishing packages.

8 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

1 rule. 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 8 edited versions we read keep these.

  • 0

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    After success, fetch release again and verify the deployed tree:

    line 57

“Common” is measured: kept by at least 6 in 10 of the 8 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Release documentation

The "Docs Release" workflow (.github/workflows/docs-release.yml) publishes apps/docs from a specified commit on main. It never versions or publishes packages. Mintlify continues to deploy release:apps/docs, but that branch is now only a docs snapshot, not a copy of the source repository or an archive of older documentation versions.

  1. Fetch the current refs:

    git fetch origin \
      refs/heads/main:refs/remotes/origin/main \
      refs/heads/release:refs/remotes/origin/release
  2. Resolve the requested source to a full commit SHA, defaulting to origin/main. Require it to be an ancestor of origin/main:

    source_sha=$(git rev-parse --verify 'origin/main^{commit}')
    git merge-base --is-ancestor "$source_sha" origin/main
    git diff --stat origin/release "$source_sha" -- apps/docs
    git diff origin/release "$source_sha" -- apps/docs

    Substitute a reviewed ref when the user requests a different source; never interpolate untrusted input into a shell command. If docs are unchanged and the deployment branch already contains only apps/docs, stop as up to date. A first deployment still needs to remove the old manifest, versioned pages, and stale workflows even when the current docs themselves are unchanged.

  3. Require a stable v10-or-later package version and its published @confect/core@<version> Git tag as an ancestor of the source. The workflow rejects prereleases, retired v9 sources, and versions with no release tag; docs-only deployment cannot promote the site before stable graduation is published. Check the requested docs against published behavior and pending changesets too: a release tag does not prove that a later docs edit describes only shipped features. Warn and get confirmation for unreleased features or an intentional rollback to an older main commit.
  4. Dispatch from main with the resolved SHA:

    gh workflow run docs-release.yml --ref main -f source_ref="$source_sha"
  5. Identify the new run with gh run list --workflow=docs-release.yml and watch it with gh run watch <run-id>. All docs deployments share one serialized queue. The workflow validates the snapshot, commits it on top of release, and performs an ordinary push; a concurrent external write fails the push rather than overwriting history. Never force-push a docs deployment.
  6. After success, fetch release again and verify the deployed tree:

    git fetch origin refs/heads/release:refs/remotes/origin/release
    git diff --exit-code "$source_sha" origin/release -- apps/docs
    git ls-tree --name-only origin/release
    git log -1 --format='%H %s' origin/release

    The root should contain only apps, with only docs below it. The deployment commit subject records the source SHA; there is no release manifest. Report the source and deployment SHAs and validation result. Confirm the public site has updated before claiming Mintlify has finished deploying.

The preparation script replaces the destination's tracked tree with the source docs, removing old .github/workflows on the first deployment. Run it only on a clean, separate checkout of release. It does not commit or push; those actions belong to the workflow after validation. The source remains untouched.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.