arch-makepkg/README.md

# `makepkg`-Action

This action builds Arch packages. It is meant to be run inside an `archlinux`
container, like the one we provide at
[aur/runner-image](https://git.michaelsasser.org/aur/runner-image), which comes
with all the necessary tools. Alternatively you could install the necessary
tools yourself before running this action.

## Inputs

| Name                      | Default  | Required | Description                                      |
| ------------------------- | -------- | -------- | ------------------------------------------------ |
| `update_package_database` | `'true'` | No       | Download fresh package databases before building |
| `update_checksum`         | `'true'` | No       | Update the checksum before building the package  |
| `lint_pkgbuild`           | `'true'` | No       | Run namecap on the PKGBUILD                      |
| `install_package`         | `'true'` | No       | Install the package after it was built           |
| `lint_package`            | `'true'` | No       | Run namecap on the resulting package             |

## Outputs

| Name      | Description                                       |
| --------- | ------------------------------------------------- |
| `package` | The name of the package file built by this action |

## Example usage

```yaml
jobs:
  build:
    name: Build & Lint
    runs-on: ubuntu-latest-amd64
    container:
      image: "git.michaelsasser.org/aur/runner-image:latest"
      credentials:
        username: ${{ vars.USERNAME_ACTIONS }}
        password: ${{ secrets.PERSONAL_ACCESS_TOKEN_ACTIONS }}

    steps:
      - name: Checkout
        uses: https://git.michaelsasser.org/actions/checkout@v4

      - name: Build Package
        uses: https://git.michaelsasser.org/actions/makepkg@main
```

## Semantic Versioning and Branching Model

This action uses [SemVer](https://semver.org/) for its release cycle and
follows the
[GitHub Flow](https://docs.github.com/en/get-started/using-github/github-flow).

## License

Copyright &copy; 2024 Michael Sasser <Info@MichaelSasser.org>. Released under
the MIT license.