Skip to content

docs: rewrite the README - #197

Merged
dnlopes merged 1 commit into
mainfrom
docs/rewrite-readme
Nov 7, 2026
Merged

dnlopes merged 1 commit into
mainfrom
docs/rewrite-readme

Conversation

@dnlopes

@dnlopes dnlopes commented Nov 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Rewrites the README so a consumer can find the right workflow and call it correctly.

  • Lists all ten consumer-facing workflows, adding react.yaml and docker-build.yaml.
  • Fixes input names that the workflows don't accept:
    • Python: testsCommand, not testCommand. CODECOV_TOKEN is required.
    • Terraform: terraformAction, terraformWorkspace, terraformVarsFile. There is no awsRegion input; the region is eu-west-1.
    • Trivy: projectDir, not scanDirectory.
  • Describes the shared inputs (ignoreErrors, directory inputs, runsOn) once, and points to each workflow's on.workflow_call block for the full input list.
  • Removes the MIT license section, because the repository has no LICENSE file, and the front matter.
  • Adds a documentation table and a short development section.

Test plan

  • Input names and defaults checked against .github/workflows/*.yaml
  • Examples not run in a consumer repository

Fix wrong input names in the Python, Terraform, and Trivy examples, list
the React and Docker build workflows, and drop the license section and
front matter.
@dnlopes dnlopes added the patch Backwards-compatible bug fixes label Nov 7, 2026
@github-actions github-actions Bot added size-L Large size changes chore Changes that do not modify src or test files labels Nov 7, 2026
@github-actions

github-actions Bot commented Nov 7, 2026

Copy link
Copy Markdown
Contributor

Trivy Security Scan Results

Note

No vulnerabilities found


Scan performed by Trivy v0.69.3

@dnlopes
dnlopes merged commit d5953ea into main Nov 7, 2026
4 checks passed
@dnlopes
dnlopes deleted the docs/rewrite-readme branch November 7, 2026 00:16
@github-actions

github-actions Bot commented Nov 7, 2026

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 1.31.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@github-actions github-actions Bot added the released Issue already released label Nov 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Changes that do not modify src or test files patch Backwards-compatible bug fixes released Issue already released size-L Large size changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant