cloudposse-github-actions/README Generator
Rebuilds README.md and associated banners from templates and README.yaml metadata and runs link validation. This opinionated implementation builds upon Cloud Posse's build-harness and README.yaml used through out Cloud Posse's GitHub repositories.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| token | GitHub API token (use a PAT if you need to trigger other actions) | no | ${{ github.token }} |
| repository_org | GitHub organization or user name used for the banner templates | no | "" |
| repository_name | GitHub repository name in the `repository_org` that hosts the banner templates | no | "" |
| repository_description | GitHub repository description | no | "" |
| banner_enabled | Enable banner generation | no | true |
| readme_enabled | Enable README generation | no | true |
| command | Atmos command to generate readme | yes | docs generate readme |
| validate_readme | Validate the README.md file using markdown-link-check | no | true |
| commit_method | The method to apply changes. Can be either 'commit' or 'pr'. | yes | commit |
| commit_push_options | The push options to use when committing changes. Use --force-with-lease to avoid overwriting changes when pushing to a protected branch using admin or bypass privileges. See https://git-scm.com/docs/git-push#_options for more. | — | "" |
| commit_message | The commit message to use when committing changes. | — | chore: update README.md |
| commit_user_name | The user name to use when committing changes. | — | readme-action 📖 |
| commit_user_email | The user email to use when committing changes. | — | actions@github.com |
| commit_author | The author to use when committing changes. | — | readme-action 📖 <actions@github.com> |
| pr_base_branch | Repo default base-branch for Pull Requests (when commit_method: pr) | no | "" |
| pr_branch | Branch to create Pull Requests from (when commit_method: pr). Suggest using a protected branch for auto-merge capabilities. | no | auto-update/readme |
| pr_title | The title to use when creating a Pull Request (when commit_method: pr) | — | Update README.md and docs |
| pr_labels | Whitespace-separated list of labels to apply to Pull Requests (when commit_method: pr or ( commit_method: commit and github context is a PR) )) | no | auto-update no-release readme |
| sign-commits | Sign commits for `pr` commit_method as `github-actions[bot]` when using `GITHUB_TOKEN`, or your own bot when using GitHub App tokens. | — | false |
| atmos-version | The version of atmos to install | no | >= 1.175.0 |
Outputs
| name | description |
|---|---|
| banner_file | Generated banner file path (if banner_enabled: true) |
| readme_file | Generated README file path (if readme_enabled: true) |
| changes_detected | Changes detected |