https://github.com/julia-actions/add-julia-registry
Add a private Julia registry
https://github.com/julia-actions/add-julia-registry
Last synced: 3 months ago
JSON representation
Add a private Julia registry
- Host: GitHub
- URL: https://github.com/julia-actions/add-julia-registry
- Owner: julia-actions
- License: mit
- Created: 2021-07-18T00:27:11.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-07T14:58:04.000Z (about 1 year ago)
- Last Synced: 2024-08-10T18:44:05.844Z (11 months ago)
- Language: JavaScript
- Size: 212 KB
- Stars: 7
- Watchers: 5
- Forks: 6
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Add Julia Registry
Handles Git authentication to private Julia packages and registries such that they can be used within a CI environment. After running this action any GitHub HTTPS request made by Pkg will be automatically authenticated.
Currently, this action only support private packages hosted within GitHub.
Access to private packages requires you to create a [SSH private key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh) or a [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) (with the proper repository access) in GitHub.
## SSH Access
```yaml
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: julia-actions/setup-julia@v2
with:
version: "1"
- uses: julia-actions/cache@v2
- uses: julia-actions/add-julia-registry@v2
with:
registry: MyOrg/MyRegistry
ssh-key: ${{ secrets.SSH_KEY }}
- uses: julia-actions/julia-runtest@v1
```
When using the SSH protocol this action performs the following steps:
- Starts [`ssh-agent`](https://linux.die.net/man/1/ssh-agent).
- Adds the supplied private key to the SSH agent.
- Configures Git to rewrite HTTPS URLs to SSH URLs (e.g. `https://github.com/foo/bar` to `[email protected]:foo/bar`).
- Downloads the specified registry and the [General](https://github.com/JuliaRegistries/General) registry.
## HTTPS Access
```yaml
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: julia-actions/setup-julia@v2
with:
version: "1"
- uses: julia-actions/cache@v2
- uses: julia-actions/add-julia-registry@v2
with:
registry: MyOrg/MyRegistry
protocol: https
github-token: ${{ secrets.GITHUB_TOKEN }} # Using `${{ github.token }}` won't work for most use cases.
- uses: julia-actions/julia-runtest@v1
```
When using the HTTPS protocol this action performs the following steps:
- Configures Git to rewrite unauthenticated HTTPS URLs to authenticated HTTPS URLs (e.g. `https://github.com/foo/bar` to `https://git:ghp_*****@github.com/foo/bar`)
- Downloads the specified registry and the [General](https://github.com/JuliaRegistries/General) registry.