diff --git a/docs/book/how-to/project-setup-and-management/setting-up-a-project-repository/connect-your-git-repository.md b/docs/book/how-to/project-setup-and-management/setting-up-a-project-repository/connect-your-git-repository.md index 063f316fef..d2e82e82a5 100644 --- a/docs/book/how-to/project-setup-and-management/setting-up-a-project-repository/connect-your-git-repository.md +++ b/docs/book/how-to/project-setup-and-management/setting-up-a-project-repository/connect-your-git-repository.md @@ -54,6 +54,21 @@ zenml code-repository register --type=github \ where \ is the name of the code repository you are registering, \ is the owner of the repository, \ is the name of the repository, \ is your GitHub Personal Access Token and \ is the URL of the GitHub instance which defaults to `https://github.com.` You will need to set a URL if you are using GitHub Enterprise. +{% hint style="warning" %} +Please refer to the section on using secrets for stack configuration in order to securely store your GitHub +Personal Access Token. + +```shell +# Using central secrets management +zenml secret create github_secret \ + --pa_token= + +# Then reference the username and password +zenml code-repository register ... --token={{github_secret.pa_token}} + ... +``` +{% endhint %} + After registering the GitHub code repository, ZenML will automatically detect if your source files are being tracked by GitHub and store the commit hash for each pipeline run.
@@ -96,6 +111,21 @@ zenml code-repository register --type=gitlab \ where `` is the name of the code repository you are registering, `` is the group of the project, `` is the name of the project, \ is your GitLab Personal Access Token, and \ is the URL of the GitLab instance which defaults to `https://gitlab.com.` You will need to set a URL if you have a self-hosted GitLab instance. +{% hint style="warning" %} +Please refer to the section on using secrets for stack configuration in order to securely store your GitLab +Personal Access Token. + +```shell +# Using central secrets management +zenml secret create gitlab_secret \ + --pa_token= + +# Then reference the username and password +zenml code-repository register ... --token={{gitlab_secret.pa_token}} + ... +``` +{% endhint %} + After registering the GitLab code repository, ZenML will automatically detect if your source files are being tracked by GitLab and store the commit hash for each pipeline run.