{"id":50870200,"url":"https://github.com/verzly/setup-aube","last_synced_at":"2026-06-15T04:33:48.146Z","repository":{"id":352915352,"uuid":"1216741357","full_name":"verzly/setup-aube","owner":"verzly","description":"Install aube package manager","archived":false,"fork":false,"pushed_at":"2026-04-22T06:33:09.000Z","size":22,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-06-15T04:33:47.848Z","etag":null,"topics":["aube","aube-package-manager","continuous-integration","dependency-management","github-action","github-workflow","linux","macos","windows"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/verzly.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-04-21T07:29:59.000Z","updated_at":"2026-04-22T06:37:17.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/verzly/setup-aube","commit_stats":null,"previous_names":["verzly/setup-aube"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/verzly/setup-aube","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/verzly%2Fsetup-aube","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/verzly%2Fsetup-aube/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/verzly%2Fsetup-aube/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/verzly%2Fsetup-aube/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/verzly","download_url":"https://codeload.github.com/verzly/setup-aube/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/verzly%2Fsetup-aube/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34348291,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-15T02:00:07.085Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aube","aube-package-manager","continuous-integration","dependency-management","github-action","github-workflow","linux","macos","windows"],"created_at":"2026-06-15T04:33:45.772Z","updated_at":"2026-06-15T04:33:48.137Z","avatar_url":"https://github.com/verzly.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# verzly/setup-aube\n\n```yaml\n- uses: verzly/setup-aube@v1\n```\n\n`verzly/setup-aube` installs aube in GitHub Actions using official release binaries.\n\nIt resolves versions from npm dist-tags, downloads the matching upstream binary from aube GitHub repository, adds it to `PATH`, and can optionally run install commands in a pnpm-style workflow.\n\n* [Usage](#usage)\n  * [Basic](#basic)\n  * [With explicit version](#with-explicit-version)\n  * [With automatic install](#with-automatic-install)\n  * [Advanced `run_install`](#advanced-run_install)\n  * [Inputs](#inputs)\n  * [Outputs](#outputs)\n* [How it works](#how-it-works)\n* [Version resolution](#version-resolution)\n* [Example workflow](#example-workflow)\n* [Contributing](#contributing)\n\n## Usage\n\nUse this action to install `aube` in your workflow and make it available on the `PATH` for subsequent steps.\n\nIt works on `x64` and `arm64` runners across Linux, macOS, and Windows, and requires no additional setup.\n\n\u003e [!NOTE]\n\u003e Node.js is not required to use aube itself. However, since aube manages JavaScript packages, installing Node.js is recommended if you plan to run those packages.\n\n### Basic\n\nThis installs the latest version of `aube` and lets you run commands directly:\n\n```yaml\nsteps:\n  - uses: actions/checkout@v6\n\n  # Install the latest aube release\n  - uses: verzly/setup-aube@v1\n\n  - run: aube install\n```\n\n\u003e [!NOTE]\n\u003e This action supports moving tags such as `@latest`, `@v1`, and `@v1.2`, as well as exact versions like `@v1.2.3`.\n\u003e In general, `@v1` is recommended for most workflows, while `@v1.2.3` is best for strict reproducibility.\n\n### With explicit version\n\nIf you need a specific version (for reproducibility or debugging), you can pin it:\n\n```yaml\nsteps:\n  - uses: actions/checkout@v6\n\n  - uses: verzly/setup-aube@v1\n    with:\n      version: v1.0.0-beta.10\n\n  - run: aube install\n```\n\n### With automatic install\n\nTo automatically install dependencies as part of setup:\n\n```yaml\nsteps:\n  - uses: actions/checkout@v6\n\n  - uses: verzly/setup-aube@v1\n    with:\n      run_install: true\n```\n\nThis is equivalent to running `aube install` right after setup.\n\n### Advanced `run_install`\n\nFor more control, you can pass a structured configuration:\n\n```yaml\n- uses: verzly/setup-aube@v1\n  with:\n    run_install: |\n      command: ci\n      cwd: app\n      args:\n        - --prod\n```\n\nThis allows you to customize how and where install commands are executed.\n\n### Inputs\n\n| Name          | Description                               | Default  |\n| ------------- | ----------------------------------------- | -------- |\n| `version`     | aube version (`latest`, `next`, or exact) | `latest` |\n| `run_install` | Run `aube install` automatically          | `null`   |\n\n### Outputs\n\n| Name      | Description                                   |\n| --------- | --------------------------------------------- |\n| `version` | Resolved aube version (e.g. `v1.0.0-beta.10`) |\n| `bin-dir` | Directory added to PATH                       |\n\n## How it works\n\nThis action installs `aube` by resolving the requested version from npm, downloading the matching prebuilt binary from the official releases, extracting it, and adding it to the system `PATH`. Once installed, it can optionally run `aube install` (or other install commands) as part of the setup.\n\nThis action avoids using the GitHub API entirely, which means it does not run into rate limits and does not require any authentication token. Instead of installing `aube` through npm, it relies on the official prebuilt binaries, so there is no Node-based wrapper involved.\n\nBy using native binaries directly, the setup remains fast and predictable. The same approach works consistently across Linux, macOS, and Windows, making it a reliable choice for CI environments where reproducibility and simplicity are important.\n\n## Version resolution\n\nThe action supports `latest`, `next`, and exact versions such as:\n\n```yaml\nversion: v1.0.0-beta.10\n```\n\nWhen `latest` or `next` is used, the action resolves the actual version by querying npm dist-tags:\n\n```sh\nnpm view @endevco/aube dist-tags --json\n```\n\nThis allows us to determine the current release version without relying on the GitHub API. By using npm as the source of truth for version tags, the action avoids the need for a GitHub token and eliminates the risk of hitting GitHub API rate limits.\n\n## Example workflow\n\n```yaml\nname: CI\n\non:\n  push:\n  pull_request:\n\njobs:\n  build:\n    runs-on: ubuntu-latest\n\n    steps:\n      - uses: actions/checkout@v6\n\n      # Optional but recommended if running JS packages\n      - uses: actions/setup-node@v6\n        with:\n          node-version: 24\n\n      - uses: verzly/setup-aube@v1\n\n      # Optional: cache dependencies\n      - name: Cache aube store\n        uses: actions/cache@v6\n        with:\n          path: ~/.aube\n          key: ${{ runner.os }}-aube-${{ hashFiles('**/aube.lock') }}\n          restore-keys: |\n            ${{ runner.os }}-aube-\n\n      - run: aube install\n      - run: aube test\n```\n\n## Contributing\n\nTo contribute to this project, start by installing the required tools using mise:\n\n```sh\nmise install\n```\n\nThis installs everything defined in `mise.toml`, including aube and hk.\n\nThe action is bundled using:\n\n```sh\naube package\n```\n\nwhich generates the compiled output in:\n\n```\ndist/index.js\n```\n\nHowever, you usually don't need to run this manually. The repository is configured with `hk` pre-commit hooks. After installing them with:\n\n```sh\nhk install\n```\n\nevery commit will automatically:\n\n* run `aube package`\n* update and stage the `dist/` directory\n\nThis ensures that the committed build output is always in sync with the source code.\n\n### WSL note (important)\n\nIf you are using WSL, make sure to run Git from the same environment where you are developing. Avoid mixing Windows Git with the WSL filesystem (or the other way around), as this can prevent hooks from running correctly.\n\n### Workflow summary\n\n```sh\nmise install\nhk install\n\n# develop...\n\ngit commit\n```\n\nBuild and `dist/` updates are handled automatically as part of the commit process.\n\n## License \u0026 Acknowledgments\n\nThis project would not exist without the creators and contributors of [aube](https://github.com/endevco/aube). It is open source and released under the [GNU Affero General Public License v3.0 (AGPL-3.0)](https://www.gnu.org/licenses/agpl-3.0.html).\n\nCopyright (C) 2020—present [Zoltán Rózsa](https://github.com/rozsazoltan) \u0026 [Verzly](https://github.com/verzly)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fverzly%2Fsetup-aube","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fverzly%2Fsetup-aube","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fverzly%2Fsetup-aube/lists"}