cloudposse / cloudposse/terraform-aws-github-action-token-rotator

Doc updates

Open
#4 0 comments 0 reactions 0 assignees View on GitHub
bug
Dominant language
HCL
Stars
3
Forks
2
PR merge metrics
No merged PRs in 30d

Description

Found a bug? Maybe our [Slack Community](https://slack.cloudposse.com) can help.

[![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)

## Describe the Bug
Some missing steps

- The app needs to be installed before the installation ID can be retrieved
- The installation id cannot be retrieved easily. First the JWT has to be derived from the private key and github app id, then the JWT can be used to get the installation ID
- The installation id is also in the url of the github install
- `chamber` cannot save snake cased keys to ssm so it's better to use `private-key` instead of `privateKey`

Contributor guide

Open the contributing guide

Research direction

Review the repository documentation covering GitHub App installation and installation ID retrieval. Clarify the JWT and app-installation steps, mention the installation ID in the GitHub install URL, and document using `private-key` with chamber so snake-cased keys can be saved to SSM.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.