Skip to content

Releases: cloudposse-github-actions/readme

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

v0.2.0

01 May 00:11
8026082

Choose a tag to compare

Use github token for checkout @goruha (#10)

What

  • Use github token input for checkout

Why

  • To inherit github app permissions

v0.1.0

29 Apr 20:05
b4d270d

Choose a tag to compare

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, --force or --force-with-lease need to be used.
set max-depth to 0 for link checker @osterman (#6)

what

  • Set max-depth to 0

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-path input. 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.md and 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
Use proper _extends keyword @osterman (#3)

what

  • Replace extends with _extends in settings.yml

why

  • Mergify and Probot use similar keyword for extends, but probot is prefixed with _
  • accidentally used the wrong keyword
Add essential scaffolding files @osterman (#2)

what

  • Add mergify and repo settings configs

why

  • Necessary for workflows