Skip to content

Add documentation to authenticate to private go modules #88

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

Merged
merged 2 commits into from
Jun 6, 2025

Conversation

ljones140
Copy link
Contributor

Part of: https://github.com/github/dependency-graph/issues/6446

Adds documentation for private module authentication.

@Copilot Copilot AI review requested due to automatic review settings June 4, 2025 13:41
@ljones140 ljones140 requested a review from a team as a code owner June 4, 2025 13:41
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Adds a new documentation section explaining how to authenticate to private Go modules in GitHub Actions workflows, including methods, environment variables, and a concrete example.

  • Introduces “Accessing Private Go Modules” with HTTPS and SSH authentication methods
  • Lists relevant Go environment variables for private modules
  • Provides a full YAML workflow example using a Personal Access Token
Comments suppressed due to low confidence (2)

README.md:63

  • [nitpick] Use consistent Markdown link formatting for readability, e.g. [Go FAQ](https://go.dev/doc/faq#git_https) instead of a raw URL.
See official Go documentation for more information at https://go.dev/doc/faq#git_https

README.md:103

  • The example sets GOPROXY to an empty string but earlier suggests using direct to bypass proxies; consider aligning the example with that recommendation or clarifying the behavior when GOPROXY is empty.
GOPROXY: '' # A Go Proxy server to be used

elrayle
elrayle previously approved these changes Jun 6, 2025
Copy link
Contributor

@elrayle elrayle left a comment

Choose a reason for hiding this comment

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

Thanks for adding the additional documentation. That will help users with private dependencies.

I have one suggestion to improve the GOPROXY value in both examples.

Co-authored-by: E. Lynette Rayle <elrayle@users.noreply.github.com>
@ljones140 ljones140 merged commit 9750009 into main Jun 6, 2025
3 checks passed
@ljones140 ljones140 deleted the ljones140/example-for-private-go-modules branch June 6, 2025 14:39
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.

2 participants