https://github.com/bsc-quantic/julia-register
GitHub action for registering packages in federated registries
https://github.com/bsc-quantic/julia-register
action github github-actions julia registry
Last synced: about 2 months ago
JSON representation
GitHub action for registering packages in federated registries
- Host: GitHub
- URL: https://github.com/bsc-quantic/julia-register
- Owner: bsc-quantic
- License: apache-2.0
- Created: 2023-03-15T19:38:45.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-06-26T15:01:39.000Z (about 3 years ago)
- Last Synced: 2026-04-01T01:07:06.973Z (3 months ago)
- Topics: action, github, github-actions, julia, registry
- Language: Julia
- Homepage:
- Size: 42 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# julia-register
_A GitHub action to register Julia packages in federated registries._
You can think of it as the official [Register Julia Package](https://github.com/marketplace/actions/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
```yaml
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.