Releases: cloudposse-github-actions/readme
Releases · cloudposse-github-actions/readme
v2.0.1
Change GitHub Action to use ci.yml workflow @goruha (#31)
## what * Change GitHub Action to use ci.yml workflowFix readme linting technical files @goruha (#30)
## what * Remove technical fileswhy
- Prevent committing autogenerated technical files
🤖 Automatic Updates
v2.0.0
v1.2.0
v1.1.0
v1.0.0
Use atmos to generate readme @goruha (#23)
## what * Use atmos to generate readmewhy
- Build-harness is depricated
Migrating from v0 to v1
v1 use atmos instead of build-harness.
You can drop Makefile if you use it only for readme generation.
To support atmos reaadme generation, you must create atmos.yaml config.
The configuration depends on your repo - please follow this documentation
Example:
docs:
generate:
readme:
base-dir: .
input:
- "./README.yaml"
template: "https://.../README.md.gotmpl"
output: "./README.md"
terraform:
source: src/
enabled: false
format: "markdown"
show_providers: false
show_inputs: true
show_outputs: true
sort_by: "name"
hide_empty: false
indent_level: 2v0.5.0
v0.4.0
v0.3.0
Use GitHub Action Workflows from `cloudposse/.github` Repo @goruha (#12)
## what - Update workflows (`.github/workflows/settings.yaml`) to use shared workflows from `.github` repowhy
- Reduce nested levels of reusable workflows
Fix yaml parse @goruha (#11)
## What * Replace `actions-tools/yaml-outputs` with `mikefarah/yq`Why
actions-tools/yaml-outputshave bug actions-tools/yaml-outputs#23- To fix https://github.com/cloudposse/github-action-atmos-terraform-select-components/actions/runs/9073104579/job/24929685906
v0.2.0
v0.1.0
Update actions @osterman (#8)
what
- Bump auto-commit and pull request actions
why
- use latest node
- bug fixes
Support push options @osterman (#7)
what
- Add support for push options
- Customizable branches
- Update actions
why
- In order to push to protected branches,
--forceor--force-with-leaseneed to be used.
set max-depth to 0 for link checker @osterman (#6)
what
- Set
max-depthto0
why
- It's not respecting checking only modified files and it's recursing deep into all folders. Not sure what else to try.
Only validate modified files @osterman (#5)
what
- attempt to only validate files modified
- fix usage example
why
- by default, it seems to want search all files in the directory, not just those specified by the
file-pathinput. This causes it to hit 429 rate limit issues. - Validating files not modified should not be in scope
Initial implementation @osterman (#1)
what
- Add an opionated implementation to regenerate the
README.mdand banners
why
- We need this functionality across our enterprise and it's a bit hairy
Fix mergify config @osterman (#4)
what
- Refer to .github repo instead of org & repo
why
- Relative repo is less error prone