README.md

.______    __  ___  __    __  .______
|   _  \  |  |/  / |  |  |  | |   _  \
|  |_)  | |  '  /  |  |  |  | |  |_)  |__ _  ___ _ __
|   ___/  |    <   |  |  |  | |   ___// _' |/ _ \ '_ \
|  |      |  .  \  |  '--'  | |  |   | (_| |  __/ | | |
| _|      |__|\__\  \______/  | _|    \__, |\___|_| |_|action
                                      |___/

---

Easy-to-use action allows generating PKUP reports and sending them zipped using the most popular email servers.

Configuration

Action requires the .pkupcompose.yaml file located in the repository root directory and can be configured by passing additional (not required) inputs.

Usage

- uses: pPrecel/pkup-gen-action@v1
    with:
      # if true use the `.pkupcompose.yaml` file to generate reports
      # (default: `treu`)
      generate: 'true'

      # if true send emails to reports owners described in the `.pkupcompose.yaml` file 
      # based on the `.reports[].email` fields
      # (default: `true`)
      send-emails: 'true'

      # timestamp used to generate reports - foramt 02.01.2006
      # (default: 19th day of past month)
      since: "02.19.2024"
      
      # timestamp used to generate reports - foramt 02.01.2006
      # (default: 18th day of actual month)
      until: "03.18.2024"

.pkupcompose.yaml

The action uses the .pkupcompose.yaml file documented here.