forked from navikt/github-app-token-generator
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
1 changed file
with
19 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,42 +1,19 @@ | ||
# GitHub App installation access token generator | ||
|
||
GitHub Action that can be used to generate an installation access token for a GitHub App. This token can for instance be used to clone repos, given the GitHub App has sufficient permissions to do so. | ||
|
||
## Usage | ||
|
||
```yaml | ||
name: Checkout repos | ||
on: push | ||
jobs: | ||
checkout: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
|
||
- uses: idealo/[email protected] | ||
id: get-token | ||
with: | ||
private-key: ${{ secrets.IDEALO_BOT_GH_APP_PRIVATE_KEY }} | ||
app-id: ${{ secrets.IDEALO_BOT_GH_APP_ID }} | ||
|
||
- name: Check out an other repo | ||
uses: actions/checkout@v2 | ||
with: | ||
repository: owner/repo | ||
token: ${{ steps.get-token.outputs.token }} | ||
``` | ||
## Requirements | ||
The action needs two input parameters, `private-key` and `app-id`. To get these, simply create a GitHub App. The private key can be generated and downloaded, and should be added to the repos as a secret. | ||
|
||
The installation ID that is used during the creation of the access token is created against the repo running the action. If you need to create the installation ID for a different repo you can use the `repo` input: | ||
|
||
```yaml | ||
uses: idealo/[email protected] | ||
id: get-token | ||
with: | ||
private-key: ${{ secrets.IDEALO_BOT_GH_APP_PRIVATE_KEY }} | ||
app-id: ${{ secrets.IDEALO_BOT_GH_APP_ID }} | ||
repo: some/repo | ||
``` | ||
## Getting started | ||
|
||
Start write your documentation by adding more markdown (.md) files to this folder (/docs) or replace the content in this file. | ||
|
||
## Table of Contents | ||
|
||
The Table of Contents on the right is generated automatically based on the hierarchy | ||
of headings. Only use one H1 (`#` in Markdown) per file. | ||
|
||
## Site navigation | ||
|
||
For new pages to appear in the left hand navigation you need edit the `mkdocs.yml` | ||
file in root of your repo. The navigation can also link out to other sites. | ||
|
||
|
||
Note that MkDocs uses `mkdocs.yml`, not `mkdocs.yaml`, although both appear to work. | ||
See also <https://www.mkdocs.org/user-guide/configuration/>. | ||
|
||
our action supports Mermaid.js and plantUML for drawing diagrams |