Skip to content

Commit fdfb417

Browse files
committed
Add info about user-env-compile and pipeline.
1 parent 2532f88 commit fdfb417

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
Heroku buildpack: Github private repo access via ~/.netrc
22
===================================
33

4-
This buildpack uses a Github OAuth2 token exposed as `GITHUB_BASIC_TOKEN`
4+
This buildpack uses a Github OAuth2 token exposed as `GITHUB_AUTH_TOKEN`
55
to resolve private repository URLs without putting a specific username
66
or password in the URLs saved in local files (e.g. `package.json`).
77

88
See [Easier builds and deployments using Git over HTTPS and
9-
OAuth][github-builds] and [Github OAuth — Non-web Application Flow][github-oauth] for more detail. Also, you may want to choose a user with read-only access
9+
OAuth][github-builds] and [Github OAuth — Non-web Application Flow][github-oauth] for more detail. Also, you may want to choose a user with read-only access.
10+
11+
If you use this in conjunction with the `labs:pipeline` feature of Heroku, you may
12+
avoid setting the `GITHUB_AUTH_TOKEN` environment variable on your test & prod apps,
13+
and instead only set it on the app where you push your code & which runs the buildpack.
1014

1115
[github-builds]: https://github.com/blog/1270-easier-builds-and-deployments-using-git-over-https-and-oauth
1216

@@ -17,7 +21,10 @@ Example usage:
1721

1822
$ heroku create --stack cedar --buildpack http://github.com/fs-webdev/heroku-buildpack-netrc.git
1923

20-
$ source
24+
# Enable
25+
$ heroku labs:enable user-env-compile
26+
$ heroku config:set GITHUB_AUTH_TOKEN=<my-read-only-token>
27+
2128
$ git push heroku master
2229
...
2330
-----> Heroku receiving push

0 commit comments

Comments
 (0)