This command will download the template to a directory called `nova_tutorial`. Copier will prompt you with a series of questions. Please answer the questions as follows:
@@ -174,66 +174,9 @@ The template includes a basic GitLab CI configuration file (`.gitlab-ci.yml`).
Now that we have our template application set up, we need to integrate it with the NDIP platform. The template includes built-in utilities to streamline this process, handling the GitLab repository setup and Galaxy tool XML management.
### Manual Configuration for Tutorial
Since this is a tutorial, we need to modify a few files to properly configure our repository path. In a real project, you would use your own team's project name.
#### Modify Repository Path
1. Open `scripts/git_utils.py` in your editor and modify the line setting the repository path:
@@ -60,32 +60,25 @@ The NOVA framework requires you to set environment variables for your NDIP URL a
**Important:** For security reasons, it is recommended to avoid hardcoding your API key directly in your code. Using environment variables is a more secure and flexible approach.
## 4. Create and Add SSH Key to GitLab
## 5. Create a GitLab Personal Access Token
For detailed instructions, refer to the [official GitLab SSH documentation](https://docs.gitlab.com/user/ssh/#generate-an-ssh-key-pair).
To contribute code to GitLab repositories, you'll need to set up SSH authentication:
1.**Generate an SSH key pair** if you don't already have one:
```bash
ssh-keygen -t ed25519 -C"your_email@example.com"
```
2.**Add your SSH key to the ssh-agent**:
```bash
eval"$(ssh-agent -s)"
ssh-add ~/.ssh/id_ed25519
```
::::::::::::::::::::::::::::::::::::::::: callout
3.**Add your public key to your GitLab account**:
- Copy your public key to clipboard:
```bash
cat ~/.ssh/id_ed25519.pub
```
- Go to GitLab > Preferences > SSH Keys
- Paste your key and add a descriptive title
If you currently use an ssh key for gitlab, you will still need to create a personal access token for the tutorial.