diff --git a/docs/installing.md b/docs/installing.md index ec26ccdb66..7be2fca092 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -134,6 +134,22 @@ All the arguments are optional and most users should not need them: - `requirements_file`: Path to the requirements.yml file to install role and collection dependencies. +To install roles and collections from private repositories, you can: +1. Create an [access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#about-personal-access-tokens) +1. Add the token as an [deploy secret](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository) +1. Add the following step before the ansible-lint step. + +```yaml +- name: Prepare Git for Github + shell: bash + run: | + git config --global url."https://${{ secrets.ANSIBLE_LINT_TOKEN }}@github.com".insteadOf "https://github.com" + +``` + + Due to limitations on how GitHub Actions are processing arguments, we do not plan to provide extra options. You will have to make use of [ansible-lint own configuration file](https://ansible.readthedocs.io/projects/lint/configuring/)