https://github.com/toolsascode/gomodeler-action

GitHub Action for GoModeler
https://github.com/toolsascode/gomodeler-action

ci cloud devops github-actions golang gomodeler gotemplate pltaform sre summary template

Last synced: about 1 month ago
JSON representation

GitHub Action for GoModeler

• Host: GitHub
• URL: https://github.com/toolsascode/gomodeler-action
• Owner: toolsascode
• License: mit
• Created: 2024-09-15T21:33:07.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-10-03T21:51:02.000Z (3 months ago)
• Last Synced: 2024-10-15T16:21:23.317Z (3 months ago)
• Topics: ci, cloud, devops, github-actions, golang, gomodeler, gotemplate, pltaform, sre, summary, template
• Language: Makefile
• Homepage: https://github.com/toolsascode/gomodeler
• Size: 19.5 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        



# Go Modeler for GitHub Action

GoModeler is a small CLI to facilitate the compilation of templates using the go template engine.

**See more:** 

## Changelog

Please refer to the [release page](https://github.com/toolsascode/gomodeler/releases) for the latest release notes.

## Usage

```yaml

- uses: toolsascode/gomodeler-action@v1

  with:

    # Expected log level in application output.

    # Currently the following options are supported: debug, info, warn, error, fatal or panic

    # Default: info

    log-level: info

    # List of environment variables in key=value format

    # Default: ''

    environments: |

        key=value

    # Environment variables file in YAML or JSON format.

    # Default: ''

    environment-file: /path/to/envFile.yaml

    # gotemplate code block to be rendered

    # Default: ''

    template: |

        {{ .key }}

    # List of template files for rendering.

    # Default: ''

    template-file: /path/to/templates/file.ext.gotmpl

    # Path of template files for rendering.

    # Default: ''

    template-path: /path/to/templates

    # The path where the rendered files will be stored.

    # Default: "./outputs"

    output-path: /path/to/outputs

    # Add rendered content to GITHUB_STEP_SUMMARY output.

    # Default: false

    github-step-summary: false

```

## Examples

Render templates

- This model is useful for those who only expect to compile the file and use the file for other tasks.

```yaml

- uses: toolsascode/gomodeler-action@v1

  with:

    log-level: info

    environment-file: /path/to/envFile.yaml

    template-path: /path/to/templates

    output-path: /path/to/outputs

```

Add rendered content to GitHub Step Summary

- In this case, in addition to compiling, the file is automatically added to GITHUB_STEP_SUMMARY.

```yaml

- uses: toolsascode/gomodeler-action@v1

  with:

    log-level: info

    environment-file: /path/to/envFile.yaml

    template-path: /path/to/templates

    output-path: /path/to/outputs

    github-step-summary: true

```

Customizing the GitHub Actions Summary

- A small example of how you can create your custom template file.

- In this case, in addition to compiling, the file is automatically added to GITHUB_STEP_SUMMARY.

1. Create the Template file: `summary.md.gotmpl`

```yaml

## {{ .title }}

{{ if or (empty .active_details) (.active_details | default "true" | bool) }}

    {{ .subtitle | default "Output" }}

{{ if or (empty .split_file) (not .split_file | default "false" | bool) }}

'``{{ .extension | default "yaml" }}

{{ include .filename | trim }}

'``

{{ else }}

'``{{ .extension | default "yaml" }}

{{ range (include .filename) | trim | arrayStr -}}

{{- $file := . }}

{{- if not (empty "$file") }}

{{- $file }}

{{- end }}

{{ end -}}

'``

{{ end }}

{{ end -}}

```

2. Add Workflow

```yaml

  - name: Checkout

    uses: actions/checkout@v4

  - uses: dorny/paths-filter@v3

    id: filter

    with:

      list-files: shell

      filters: |

        files:

          - added|modified: '*.go'

  - name: Generate Output files

    run: |

      echo "${{ steps.filter.outputs.files }}" > ./files.out

  - name: Step Summary - Flow files changes

    uses: toolsascode/gomodeler-action@v1

    with:

      log-level: debug

      environments: |

        title=Files Changes

        subtitle=Output

        extension=shell

        active_details=true

        split_file=true

        filename=./files.out

      template-file: ./templates/summary.md.gotmpl

      github-step-summary: true

```

### Others

**See example:** 

## License

The scripts and documentation in this project are released under the [MIT License](./LICENSE.md)