Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

README: Expand the usage instructions #1

Merged
merged 2 commits into from
Jul 1, 2022
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,21 @@ Add a private Julia package registry.

## Usage

First add a `JULIA_PKG_SERVER` environment variable to the toplevel of your workflow file that references your private package server.

```yml
env:
JULIA_PKG_SERVER: https://my-pkg-server.example.com/
```

Then add the following step after your job's [`setup-julia`](https://github.com/julia-actions/setup-julia) step.

```yml
- uses: PumasAI/add-private-registry
- uses: PumasAI/add-private-registry@COMMIT
with:
juliahub_token_encoded: ${{ secrets.JULIAHUB_TOKEN_ENCODED }}
private_registry_name: MyPrivateRegistry
private_registry_uuid: 00000000-0000-0000-0000-000000000000
env:
JULIA_PKG_SERVER: https://my-pkg-server.example.com/
```

where `COMMIT` is the commit SHA that of this action that you would like to use.
MichaelHatherly marked this conversation as resolved.
Show resolved Hide resolved