Skip to content

docs

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
aws-prowler.md
aws-prowler.md
 
 
aws-remote-ssh-command.md
aws-remote-ssh-command.md
 
 
aws-ssm-send-command.md
aws-ssm-send-command.md
 
 
cf-deploy-stackset.md
cf-deploy-stackset.md
 
 
cf-deploy.md
cf-deploy.md
 
 
ci.md
ci.md
 
 
cloudrun-rollback.md
cloudrun-rollback.md
 
 
docker-build-push.md
docker-build-push.md
 
 
docker-scout.md
docker-scout.md
 
 
docker-smurf.md
docker-smurf.md
 
 
gcp-prowler.md
gcp-prowler.md
 
 
helm-deploy.md
helm-deploy.md
 
 
helm-smurf.md
helm-smurf.md
 
 
infracost.md
infracost.md
 
 
notify-slack.md
notify-slack.md
 
 
pr-auto-assignee.md
pr-auto-assignee.md
 
 
pr-checks.md
pr-checks.md
 
 
pr-claude-review.md
pr-claude-review.md
 
 
pr-gemini-review.md
pr-gemini-review.md
 
 
pr-gitleaks-scan.md
pr-gitleaks-scan.md
 
 
pr-lock.md
pr-lock.md
 
 
pr-stale.md
pr-stale.md
 
 
readme.md
readme.md
 
 
release-changelog.md
release-changelog.md
 
 
release-maintain-major-tag.md
release-maintain-major-tag.md
 
 
release-tag.md
release-tag.md
 
 
security-checkov.md
security-checkov.md
 
 
security-powerpipe.md
security-powerpipe.md
 
 
security-prowler.md
security-prowler.md
 
 
security-tfsec.md
security-tfsec.md
 
 
sst.md
sst.md
 
 
stf-checks.md
stf-checks.md
 
 
tf-checks.md
tf-checks.md
 
 
tf-diff-checks.md
tf-diff-checks.md
 
 
tf-drift.md
tf-drift.md
 
 
tf-lint.md
tf-lint.md
 
 
tf-monorepo-tag-release.md
tf-monorepo-tag-release.md
 
 
tf-smurf.md
tf-smurf.md
 
 
tf-workflow.md
tf-workflow.md
 
 
yml-lint-internal.md
yml-lint-internal.md
 
 
yml-lint.md
yml-lint.md
 
 

readme.md

Readme Workflow

This workflow is used to generate readme for TErraform modules using GitHub Actions. It utilizes the workflows defined in .github/workflows/readme.yml

Example of a readme workflow

name: readme workflow
on:
  push:
    branches:
      - master
    paths-ignore:
      - 'README.md'
  workflow_dispatch:
jobs:
  assignee:
    uses: clouddrove/github-shared-workflows/.github/workflows/readme.yml@v2
    secrets:
      TOKEN :                  # Provide GitHub token 
      SLACK_WEBHOOK_TERRAFORM: # Provide slack-webhook url