heroku / heroku/heroku-buildpack-nodejs

Add workflow for private github dependencies

Open
#498 2 comments 3 reactions 0 assignees View on GitHub
documentation
Dominant language
Shell
Stars
1.3k
Forks
2.6k
Avg merge
1d 13h
Merged PRs (30d)
30

Description

Using private github repos as dependencies is a common pattern, but people are often tripped up with the auth flow. It seems a lot of people end up here: https://stackoverflow.com/questions/10869796/npm-private-git-module-on-heroku/13353408#13353408 but the top answer involves putting access tokens into your git history, which we should not encourage.

Instead, we should build https://github.com/timshadel/heroku-buildpack-github-netrc into the Node buildpack and document its use. We can use a special env var like `NODE_BUILDPACK_GITHUB_AUTH_TOKEN` and generate the `.netrc` for the user.

Contributor guide

Open the contributing guide

Research direction

The issue names the Node buildpack and the referenced heroku-buildpack-github-netrc; start by reviewing those entry points and the proposed NODE_BUILDPACK_GITHUB_AUTH_TOKEN flow. Done means private GitHub dependencies can authenticate without tokens in Git history, and the workflow is documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, github, nodejs
Domain
build-system, security
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.