setup-gitannex/README.md

Forgejo Action for setting up git-annex

A composite Forgejo Action that installs git-annex with uv, configures a Git identity, and optionally provisions non-interactive credentials for private repository access. Upon completion, a workflow can use git-annex any following steps, including get and push operations from and to the repository that triggered a workflow run.

The action is implemented such that it should also run on GitHub actions. However, no attempt is made to verify this, and it is purely based on the similarity of these two systems for the time being.

Usage

- name: Set up git-annex
  uses: https://hub.datalad.org/git-annex/setup-gitannex-action@v1

Parameters

The following optional parameters can be given via the with key. Example:

- name: Set up git-annex
  uses: https://hub.datalad.org/git-annex/setup-gitannex-action@v1
  with:
    enable-private-repo-access: "false"
    ...

Name	Default	Description
version	""	Optional git-annex version identifier to install. See the PyPI release history for available versions.
git-name	Workflow runner	Git user name used for commits created by git-annex.
git-email	""	Git user email used for commits created by git-annex. If unset, a surrogate email is generated from the actor identity and server URL.
enable-private-repo-access	true	Cache the action actor/token credential for non-interactive access by git-annex.

License

MIT