Add link to docs in warning about missing GitHub authentication token
Open
Nobody has claimed this yet.
download
enhancement
good-first-issue
- Dominant language
- Python
- Stars
- 322
- Forks
- 255
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 5
Description
Description of feature
@mashehu suggests that the WARNING Could not find GitHub authentication token. Some API requests may fail. should contain a link to docs on how to setup GitHub auth token.
https://nfcore.slack.com/archives/CE5LG7WMB/p1715582460445269
The warning was thrown in the following kind of situation:
$ nf-core download
,--./,-.
___ __ __ __ ___ /,-._.--~\
|\ | |__ __ / ` / \ |__) |__ } {
| \| | \__, \__/ | \ |___ \`-._,-`-,
`._,._,'
nf-core/tools version 2.14.1 - https://nf-co.re/
Specify the name of a nf-core pipeline or a GitHub repository name (user/repo).
? Pipeline name: bamtofastq
WARNING Could not find GitHub authentication token. Some API requests may fail.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the warning emitted by the nf-core download command and locate the code that produces the missing GitHub authentication token message. Link the warning to the documentation describing GitHub token setup, then run nf-core download in the token-missing situation to verify the link appears.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, python
- Domain
- authentication, cli
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100