README.yaml

---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: README Generator

# Tags of this project
tags:
  - github-action

# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"

# Canonical GitHub repo
github_repo: cloudposse-github-actions/readme

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/cloudposse-github-actions/readme.svg"
    url: "https://github.com/cloudposse-github-actions/readme/releases/latest"
  - name: "Slack Community"
    image: "https://slack.cloudposse.com/badge.svg"
    url: "https://slack.cloudposse.com"

related: []

# Short description of this project
description: |
  Rebuilds [`README.md`](README.md) and associated banners from templates using the [`README.yaml`](README.yaml) metadata.

author: hello@cloudposse.com

introduction: |-
  This opinionated implementation builds upon Cloud Posse's build-harness and README.yaml
  used throughout Cloud Posse's GitHub repositories.

references:
  - name: "screenshot"
    description: ""
    url: "https://github.com/cloudposse-github-actions/screenshot"

# How to use this project
usage: |-
  To use this project, follow these steps:

  Add the following code to your workflow file (e.g., `.github/workflows/readme.yml`):

  ```yaml
  name: README
  on:
    pull_request:
      branches: [ 'main' ]
      types: [opened, synchronize, reopened, closed, labeled, unlabeled]

  jobs:
    generate:
      runs-on: ubuntu-latest
      steps:
        - name: Rebuild README.md and Banner
          uses: cloudposse-github-actions/readme@v0
          id: readme
          with:
            banner_enabled: true
            readme_enabled: true

      outputs:
        banner_file: ${{ steps.readme.outputs.banner_file }}
        readme_file: ${{ steps.readme.outputs.readme_file }}
  ```

  ## Advanced Usage

  In the following example, we use the `workflow_dispatch` event to allow manual triggering of the workflow to rebuild the readme.  
  We also use the `pull_request` event to register the workflow from the PR. This allows us to test the workflow before merging
  it to the main branch.

  ```yaml
    name: README
    on:
      # Allow manual triggering of workflow to rebuild readme
      workflow_dispatch: {}

      ## Added pull_request to register workflow from the PR.
      ## Read more https://stackoverflow.com/questions/63362126/github-actions-how-to-run-a-workflow-created-on-a-non-master-branch-from-the-wo
      pull_request:
        branches-ignore: ['*']

    schedule:
      # Update README.md nightly at 4am UTC
      #         .---------------- minute (0 - 59)
      #         |  .------------- hour (0 - 23)
      #         |  |  .---------- day of month (1 - 31)
      #         |  |  |  .------- month (1 - 12) OR jan,feb,mar,apr ...
      #         |  |  |  |  .---- day of week (0 - 6) (Sunday=0 or 7) OR sun,mon,tue,wed,thu,fri,sat
      #         |  |  |  |  |
      - cron:  '0  4  *  *  *'

    jobs:
      generate:
        runs-on: ubuntu-latest
        steps:
          - name: Rebuild README.md and Banner
            uses: cloudposse-github-actions/readme@v0
            id: readme
            with:
              banner_enabled: true
              readme_enabled: true
  ```
include:
  - "docs/github-action.md"

# Contributors to this project
contributors: []