/julia-register

GitHub action for registering packages in federated registries

Primary LanguageJuliaApache License 2.0Apache-2.0

julia-register

A GitHub action to register Julia packages in federated registries.

You can think of it as the official Register Julia Package action but for private registries.

Options

Inputs

  • registry: GitHub URL to the private registry.
  • push: Optional. If true, push the branch to the registry. Defaults to true.
    • Defaults to true.
  • branch: Optional. If inputs.push=true, branch name where the registering package will be uploaded.
    • Defaults to the string returned by RegistryTools.registration_branch.
  • name: Optional. Name of the committing user.
    • Defaults to github-actions[bot].
  • email: Optional. Email of the committing user.
    • Defaults to 41898282+github-actions[bot]@users.noreply.github.com.

Outputs

  • name: Project name.
  • uuid: Project UUID.
  • version: Project version.
  • hash: Tree hash of the registering package.
  • branch: If inputs.push=true, branch where the registering package has been uploaded.
  • path: Path to the locally cloned Git repository of the private registry.

Example workflow

name: Register Package
on:
  workflow_dispatch:
jobs:
  register:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: julia-actions/setup-julia@v1
      - uses: bsc-quantic/julia-register@v0.1.3
        with:
          registry: https://github.com/YOUR_ORGANIZATION/YOUR_REGISTRY_REPO
        env:
          GITHUB_TOKEN: ${{ secrets.MY_PAT }}

Troubleshooting

Most probably, you will need a Personal Access Token (PAT) configured with Contents permissions on the registry repository. If not, the GitHub action won't be able to push the branch to the registry repository.