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

Update FAQ.md #968

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
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
8 changes: 8 additions & 0 deletions docs/src/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,3 +114,11 @@ The list of sources is a vector of [`BinaryBuilder.AbstractSource`](@ref)s. Wha
replacing `http://example.org/file.tar.gz` with the actual URL of the file you want to download.

* For a [`GitSource`](@ref), the hash is the 40-character SHA1 hash of the revision you want to checkout. For reproducibility you must indicate a specific revision, and not a branch or tag name, which are moving targets.

### How to authenticate with a github token when publishing locally?

1. Get and copy a github token with access to public repositories (check in `public_repo`)
2. Set the `GITHUB_TOKEN` environment variable to the copied token and run the Julia command as normal ([see this section for more details about publishing locally](#Can-I-publish-a-JLL-package-locally-without-going-through-Yggdrasil?)):
```shell
GITHUB_TOKEN="<40 characters of numbers and letters>" julia ... build_tarballs.jl ... --deploy=...
```
Comment on lines +118 to +124
Copy link
Member

Choose a reason for hiding this comment

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

Note that this isn't specific to local deploying, but it's for whenever you need to authenticate on GitHub (there are multiple places where this is needed). I'd rather make this section more generic, with a link to GitHub documentation, and reference this section from where it's needed