Skip to content

Commit 980fc68

Browse files
authored
Dwk/dev (#238)
* New package: LCSVD v1.0.0-DEV * replace travis section to CI section * replace travis section with CI section * add secret to the repository settings
1 parent 1181cbb commit 980fc68

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -207,8 +207,8 @@ using LocalRegistry, SomeNewPkg
207207
register(SomeNewPkg, "/home/tim/.julia/registries/HolyLabRegistry")
208208
```
209209
where you replace the specific package name and path to the appropriate value on your system.
210-
This will add a new commit to the branch of HolyLabRegistry you just created
211-
- Submit the branch as a PR to HolyLabRegistry
210+
This will add a new commit to the branch of HolyLabRegistry you just created.
211+
- Submit the branch as a PR to HolyLabRegistry.
212212
- Once the PR merges, from the HolyLabRegistry directory do
213213
```
214214
$ git checkout master
@@ -243,12 +243,16 @@ $ git branch -D teh/SomeNewPkg
243243
3bd9afcd-55df-531a-9b34-dc642dce7b95 = { name = "RFFT", path = "RFFT" }
244244
```
245245
246-
## Accessing HolyLabRegistry in CI tests
246+
## Accessing the HolyLabRegistry in a CI workflow
247247
248248
This is required only if your package uses other packages which are registered in this HolyLabRegistry registry.
249249
250+
- Set a secret key in the repository settings if you want to use private dependent packages in our lab.
251+
The key should not include a passphrase when the key pair is generated. Add the public key as a 'new SSH key'
252+
in the 'SSH and GPG keys' section of your account settings. The corresponding private key should be added as a
253+
'New repository secret' in the 'Actions secrets and variables' section of the repository settings.
250254
- Include the following lines in the jobs section of the `CI.yml` file in the `.github/workflows/` directory
251-
of your package.
255+
of your package. (Here, we assume that you set the secret key name as `SSH_PRIVATE_KEY`)
252256
253257
```
254258
name: CI
@@ -260,7 +264,7 @@ jobs:
260264
# setting ...
261265
steps:
262266
- uses: actions/checkout@v3
263-
- name: Setup SSH Keys and known_hosts # This section is required if the dependent packages include private packages in our Lab.
267+
- name: Setup SSH Keys and known_hosts # This section is required if the dependent packages include private packages in our lab.
264268
env:
265269
SSH_AUTH_SOCK: /tmp/ssh_agent.sock
266270
run: |

0 commit comments

Comments
 (0)