README.md

Compose and Send

This scenario describes how to generate many reports for given repositories and organizations and send them to developers.

NOTE: knowledge from the simple-scenario and the with-template may be useful to clarify some topics.

1. Create the .pkupgencompose.yaml file with the whole configuration ( config details here ):

   reports:
   - outputDir: reports/FILIP_STROZIK
     email: "filip.strozik@outlook.com"
     signatures:
     - username: pPrecel
     - username: internalPrecel
       enterpriseUrl: "https://github.my-corp"
     reportFields:
       pkupGenEmployeesName: "Filip Strózik"
       pkupGenJobTitle: "Senior Developer"
       pkupGenDepartment: "R&D"
       pkupGenManagersName: "John Wick"
   # - outputDir: ...
   
   template: templates/report.docx
   
   orgs:
   - name: kyma-project
     token: ghp_5...C
   - name: kyma-incubator
     token: ghp_5...C
   - name: kyma
     token: ghp_1...G
     enterpriseUrl: "https://github.my-corp"
   
   repos:
   - name: kyma-project/busola
     token: ghp_5...C
     allBranches: true
     uniqueOnly: true
   - name: kyma-project/cli
     token: ghp_5...C
     branches: ["main", "v3"]
     uniqueOnly: true
   
   send:
     serverAddress: "smtp.gmail.com"
     serverPort: 587
     username: "pkup.gen@gmail.com"
     password: my_app_password
     subject: "PKUP report"
     htmlBodyPath: "templates/email_body_template.html"
     from: pkup.gen@gmail.com

NOTE: the send field supports only basic auth. This means that for more complex usecases use email-bridge (like protonmail-bridge) or choose an Gmail service provider that supports basic authentication. For example, gmail can be used but you have to generate an app password first and be consistent with it's limitations, and outlook get rid of support for basic auth for daemon applications (read more).

2. Compose report ( example output ):

   

3. Send email ( example output ):