Skip to content

Releases: cloudposse-github-actions/readme

v3.1.0

19 Mar 22:54
bdc647d

Choose a tag to compare

Fix output file list to use spaces instead of commas @goruha (#35) ## what - Change the `file` output variable separator from commas to spaces (`${files// /,}` → `${files// / }`)

why

  • The previous substitution replaced spaces with commas, which produced an incorrect file pattern for downstream steps (e.g. git-auto-commit-action's file_pattern expects space-separated paths)
  • This was a no-op substitution bug — the intent was to preserve space-separated file paths, not convert them to comma-separated

references

  • Downstream usage in stefanzweifel/git-auto-commit-action file_pattern input

v3.0.0

19 Mar 22:34
11241e3

Choose a tag to compare

Bump GitHub Action dependency versions @goruha (#34) ## what - Bump `actions/checkout` from v4 to v6 - Bump `actions/github-script` from v7 to v8 (both usages) - Bump `cloudposse/github-action-setup-atmos` from v2 to v3 - Bump `stefanzweifel/git-auto-commit-action` from v5 to v7

why

  • Keep action dependencies up to date with their latest major versions
  • Pick up bug fixes, performance improvements, and Node.js runtime upgrades shipped in newer releases

references

🤖 Automatic Updates

Adde scheduled workflow @goruha (#33) ## what - Update workflows (`.github/workflows/`) to use `cloudposse-github-actions` org workflows

why

  • Part of migration GHA to cloudposse-github-actions org

v2.0.1

23 Sep 20:52
c52e0a9

Choose a tag to compare

Remove empty line in action.yml @goruha (#32) ## what * Minor changes to cut new release
Change GitHub Action to use ci.yml workflow @goruha (#31) ## what * Change GitHub Action to use ci.yml workflow
Fix readme linting technical files @goruha (#30) ## what * Remove technical files

why

  • Prevent committing autogenerated technical files

🤖 Automatic Updates

Replace Makefile with atmos.yaml @goruha (#29) ## what - Remove `Makefile` - Add `atmos.yaml`

why

  • Replace build-harness with atmos for readme genration

References

  • DEV-3229 Migrate from build-harness to atmos
Replace Makefile with atmos.yaml @goruha (#28) ## what - Remove `Makefile` - Add `atmos.yaml`

why

  • Replace build-harness with atmos for readme genration

References

  • DEV-3229 Migrate from build-harness to atmos

v2.0.0

09 Sep 16:16

Choose a tag to compare

Readme command usage @goruha (#27) ## what * Readme command usage

v1.2.0

21 Aug 11:17
0de2018

Choose a tag to compare

Fix mardkown linting @goruha (#25) ## what * Fix mardkown linting

v1.1.0

21 Aug 10:57

Choose a tag to compare

Added signed commits @goruha (#24) ## what * In PR mode support signed commits

why

  • Improve security

v1.0.0

26 May 18:58

Choose a tag to compare

Use atmos to generate readme @goruha (#23) ## what * Use atmos to generate readme

why

  • 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: 2

v0.5.0

18 Jun 12:01
5729f5e

Choose a tag to compare

Test workflow @goruha (#20) ## what * Test workflow
Test workflows @goruha (#19) ## what * Test workflows
Added release `pull-request` permissions @goruha (#18) ## what * Added release `pull-request` permissions
Fix typo @goruha (#17) ## what * Fix typo
Test workflow 2 @goruha (#16) ## what * Test workflow 2

v0.4.0

17 Jun 17:00
b9f6e51

Choose a tag to compare

Test workflow @goruha (#15) ## what * Test workflow
Pin workflows to current org @goruha (#14) ## what * Pin workflows to current org

why

  • Test CI org workflow

v0.3.0

21 May 19:10

Choose a tag to compare

Trigger new release workflow @goruha (#13) ## What * Minor changes

Why

  • Trigger new release workflow
Use GitHub Action Workflows from `cloudposse/.github` Repo @goruha (#12) ## what - Update workflows (`.github/workflows/settings.yaml`) to use shared workflows from `.github` repo

why

  • Reduce nested levels of reusable workflows
Fix yaml parse @goruha (#11) ## What * Replace `actions-tools/yaml-outputs` with `mikefarah/yq`

Why