Skip to content

Add documentation for github private repos#900

Open
AndyZe wants to merge 4 commits into
ros-industrial:masterfrom
AndyZe:document_github_secrets
Open

Add documentation for github private repos#900
AndyZe wants to merge 4 commits into
ros-industrial:masterfrom
AndyZe:document_github_secrets

Conversation

@AndyZe

@AndyZe AndyZe commented Jan 19, 2025

Copy link
Copy Markdown

@AndyZe

AndyZe commented Jan 23, 2025

Copy link
Copy Markdown
Author

Pinging for review. I think this is a small, straight forward change that will save people hours of research.

@130s 130s left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a weak user of Github Action and reviewed from that perspective, can't verify the legitimacy.

Comment thread doc/index.rst
Comment thread doc/index.rst Outdated

@130s 130s left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for iterating @AndyZe.

@mathias-luedtke Care to review?

@AndyZe

AndyZe commented Feb 2, 2025

Copy link
Copy Markdown
Author

Ping

@mathias-luedtke mathias-luedtke left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does not enable access to private repositories (like the Gitlab version), but clones selected repositories into the current repositories (which might lead to nested packages).

These shortcomings must be stated with a warning!
Or (preferred) we implement support for SSH secrets, like we do for Gitlab.

@mathias-luedtke

Copy link
Copy Markdown
Member

#902 adds support for a single deploy key.
#815 does something similar (but is it not supported yet).

For accessing Github (from a GHA), it might be simple to use a PAT anyway.

@mathias-luedtke

Copy link
Copy Markdown
Member

@AndyZe: #902 has feature parity with the gitlab implemantation.

For multiple deploy keys, webfactory/ssh-agent could be used as well:
https://github.com/mathias-luedtke/sshtest/blob/main/.github/workflows/main.yml#L40, but it seems to have an issue during the cleanup (webfactory/ssh-agent#184).

Comment thread doc/index.rst
@AndyZe

AndyZe commented Feb 2, 2025

Copy link
Copy Markdown
Author

Alright, I'll take the time to test #902. Thanks

Comment thread doc/index.rst Outdated
Comment thread doc/index.rst Outdated
@AndyZe

AndyZe commented Feb 5, 2025

Copy link
Copy Markdown
Author

This does not enable access to private repositories (like the Gitlab version), but clones selected repositories into the current repositories (which might lead to nested packages).

I took care of the "nested packages" issue by adding a unique path for each repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants