-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Fix the view of the start page in the docu * Tidy up actions * Avoid multiple execution of the docu workflow * Skip build doc instead of cancel * Testing action * Add base to dorny/paths-filter * Update to new version of nbconvert * Update readme * Fix version of nbclient and nbconvert * Set jupyter core version * Update example action * Delete run examples (artifact) * Add test for model description in test workflow * Correct some tests * Update readme * Update action * Add manual trigger for the test action * Update project.toml * Update project.toml * Add readme for the creation of the deploy key * Update depoy key readme * Update compat
- Loading branch information
Showing
4 changed files
with
93 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,7 +7,7 @@ on: | |
- completed | ||
push: | ||
branches: | ||
- examples | ||
- 'examples' | ||
|
||
jobs: | ||
sync-files: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
# Creation of the SSH deploy key for the CompatHelper | ||
|
||
## 1. Create an ssh key pair. | ||
This command is avaible for Windows (`cmd`) and Linux (`bash`). | ||
``` | ||
ssh-keygen -N "" -f compathelper_key -t ed25519 | ||
``` | ||
|
||
## 2. Copy the **private** key. | ||
Copy the output to your clipboard. | ||
1. Windows | ||
|
||
``` | ||
type compathelper_key | ||
``` | ||
1. Linux | ||
``` | ||
cat compathelper_key | ||
``` | ||
## 3. Create a GitHub secret. | ||
1. Open the repository on the GitHub page. | ||
1. Click on the **Settings** tab. | ||
1. Click on **Secrets**. | ||
1. Click on **Actions**. | ||
1. Click on the **New repository secret** button. | ||
1. Name the secret `COMPATHELPER_PRIV`. | ||
1. Paste the **private** key as content. | ||
## 4. Copy the **public** key. | ||
Copy the output to your clipboard. | ||
1. Windows | ||
``` | ||
type compathelper_key.pub | ||
``` | ||
1. Linux | ||
``` | ||
cat compathelper_key.pub | ||
``` | ||
## 5. Create a GitHub deploy key. | ||
1. Open the repository on the GitHub page. | ||
1. Click on the **Settings** tab. | ||
1. Click on **Deploy keys**. | ||
1. Click on the **Add deploy key** button. | ||
1. Name the deploy key `COMPATHELPER_PUB`. | ||
1. Paste the **public** key as content. | ||
1. Enable the write access for the deploy key. | ||
## 6. Delete the ssh key pair. | ||
1. Windows | ||
``` | ||
del compathelper_key compathelper_key.pub | ||
``` | ||
1. Linux | ||
``` | ||
rm -f compathelper_key compathelper_key.pub | ||
``` | ||
For more Information click [here](https://docs.juliahub.com/CompatHelper/GCWpz/2.0.1/#Instructions-for-setting-up-the-SSH-deploy-key). | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,7 @@ | ||
name: Run Tests | ||
|
||
on: | ||
workflow_dispatch: | ||
pull_request: | ||
push: | ||
branches: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters