Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for github private repos #900

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,29 @@ References:
- https://docs.gitlab.com/ce/ssh/README.html
- https://docs.gitlab.com/ee/ci/ssh_keys/README.html

(Github CI) Access to private repositories
130s marked this conversation as resolved.
Show resolved Hide resolved
------------------------------------------

Follow a process very similar to the Gitlab one, described above, to add public and private SSH keys to your repositories.
AndyZe marked this conversation as resolved.
Show resolved Hide resolved

#. Add the private SSH key to your target repository, under Settings-Secrets and Variables-Actions-Secrets.
#. Add the public SSH key to the dependency repository, under Settings-Deploy Keys.
#. Modify the industrial_ci yaml config, adding an action to clone the dependency as follows. The following example clones two dependencies:

.. code-block:: yaml

- uses: actions/checkout@v4 # dependency1
with:
ssh-key: ${{ secrets.DEPENDENCY1 }}
130s marked this conversation as resolved.
Show resolved Hide resolved
repository: your_org_name/dep1_repo
path: dep1_repo
- uses: actions/checkout@v4 # dependency2
with:
ssh-key: ${{ secrets.DEPENDENCY2 }}
repository: your_org_name/dep2_repo
path: dep2_repo


(Recommended) Subscribe to the change in this repo (industrial_ci)
---------------------------------------------------------------------------------

Expand Down