Owner: Architect:

Francesco Ilario

Story (Required)

As a Tenant Administrator,
I would like Primazactl to forward my GITHUB_TOKEN to GitHub
so that I'm not impacted by GitHub's limitations on API Requests for unauthenticated users

Background (Required)

GitHub has very restrictive limitations on API Requests for unauthenticated users.
This limitations are way less restrictive for authenticated users.

Here you can find more info about GitHub authentication.

Glossary

See glossary in architecture document

Out of scope

• read GitHub's Personal Access Token from command arguments

In Scope

• read GitHub's Personal Access Token environment variable (GITHUB_TOKEN)
• forward GitHub's Personal Access Token in primazactl's requests

Approach(Required)

To authenticate as a GitHub user, it is required to send the Github's Personal Access Token in the request's headers.
Authentication is performed as Bearer Authentication, so it is required to set the Authorization Header to Bearer GITHUB_TOKEN.
Here you can find more info about GitHub authentication.

GitHub's Personal Access Token should be read only from the environment variable GITHUB_TOKEN and used in each requests to GitHub.

Demo requirements(Required)

NA

Dependencies

NA

Edge Case

NA

BDD Tests

You can find BDD Test specification for this story in the "Testing Instruction" Field Tab or in the GitHub Issue linked to this story.
Click here for all BDD Tests Issues.

Acceptance Criteria

• Development
  primazactl reads the GitHub's Personal Access Token from the environment variable GITHUB_TOKEN
  primazactl uses the GitHub's Personal Access Token in all requests to GitHub

• Docs
  There is a section in our docs dedicated to explaining how to configure GitHub authentication in primazactl

INVEST Checklist

Dependencies identified
Blockers noted and expected delivery timelines set
Design is implementable
Acceptance criteria agreed upon
Story estimated

Legend

Unknown
Verified
Unsatisfied