autofeat docs
Operate autofeat

Actions path

The legacy GitHub Actions workflow. One path per repository.

Use either the hosted App or the GitHub Actions workflow. Do not leave both installed. Two paths will both try to comment and both try to update the journal.

The hosted path is the GitHub App autofeat-axc. It does not need .github/workflows/autofeat.yml.

What autofeat init writes

autofeat init is the Actions-path scaffold. It writes .github/workflows/autofeat.yml and .autofeat/config.yml, creates the four labels, and runs autofeat doctor. On a terminal it may offer the state ruleset.

autofeat init --repo-dir .
autofeat init --repo-dir . --force --release latest
FlagMeaning
--repo-dirConsumer checkout. Default .
--forceOverwrite an existing workflow or config. Without it, init refuses and prints a diff.
--releaselatest or vX.Y.Z, resolved to a commit. Default latest.

The generated workflow calls:

uses: a-x-c/autofeat/.github/workflows/dispatch.yml@<40-hex-sha>

Doctor WARNs when that pin is not a 40-hex SHA or a version tag. A SHA pin is PASS. A version tag is acceptable and mutable.

Triggers in the template:

  • pull_request_target: opened, labeled, synchronize, reopened
  • issue_comment: created
  • workflow_dispatch inputs: action (optional), method (optional), pr (required)

concurrency does not cancel in progress. A cancel mid-push can corrupt the branch.

Stay on the hosted App

If the App is installed, delete the Actions path:

  1. Delete .github/workflows/autofeat.yml.
  2. Delete Actions secrets AUTOFEAT_APP_ID and AUTOFEAT_APP_PRIVATE_KEY.

Keep .autofeat/config.yml, the four labels, and the autofeat-state-refs ruleset. Those are shared. See Quickstart.

On a hosted repository, autofeat doctor FAILs the workflow row because that file is missing, and FAILs app_credentials when AUTOFEAT_APP_ID and AUTOFEAT_APP_PRIVATE_KEY are unset. That is expected. Those rows are the Actions-path preflight. See CLI.

setup-app is not the hosted App

autofeat setup-app --name NAME --repo owner/repo
autofeat setup-app --verify-app APP_ID --key-path ./app.pem
FlagMeaning
--nameName for a new private App.
--repoowner/name that receives the secrets.
--forceOverwrite.
--timeoutSeconds. Default 600.
--verify-appExisting App id. Does not create an App and does not write secrets.
--key-pathPEM used with --verify-app.

Exit 2 means installation or repository access was not verified. Exit 1 is a setup error.

This command creates a private App for the Actions path. It does not install autofeat-axc.

On this page