https://github.com/marmelab/greenframe-action

GreenFrame Github Action to perform carbon footprint analysis
https://github.com/marmelab/greenframe-action

co2-emissions greenframe sustainability tech4good

Last synced: about 2 months ago
JSON representation

GreenFrame Github Action to perform carbon footprint analysis

• Host: GitHub
• URL: https://github.com/marmelab/greenframe-action
• Owner: marmelab
• License: mit
• Created: 2022-01-19T13:36:04.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-04-08T21:13:38.000Z (about 2 years ago)
• Last Synced: 2024-04-13T02:08:36.908Z (about 1 year ago)
• Topics: co2-emissions, greenframe, sustainability, tech4good
• Language: JavaScript
• Homepage:
• Size: 23.4 KB
• Stars: 4
• Watchers: 3
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GreenFrame CLI action

This action install the GreenFrame CLI and perform an analysis by using your configuration file.

![GreenFrame Documentation](https://docs.greenframe.io)

## Inputs

### `CONFIG_PATH`

The path to your config file. Default `./.greenframe.yml`.

## Environnement variable

### `GREENFRAME_SECRET_TOKEN`

You have to provide your `GREENFRAME_SECRET_TOKEN`. Do not paste it directly in your repository but use ![Github Encrypted Secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) instead.

## Example usage

Create a file: `.github/workflows/greenframe.yml`

```

on: [push]

jobs:

  greenframe_action_workflow:

    runs-on: ubuntu-latest

    name: Run a GreenFrame CLI Action

    steps:

      # To use this repository's private action,

      # you must check out the repository

      - name: Checkout

        uses: actions/checkout@v2

        with:

          fetch-depth: 0 # Fetch all the git history to enable git comparison

      - name: GreenFrame Analysis

        uses: marmelab/[email protected]

        env:

          GREENFRAME_SECRET_TOKEN: ${{secrets.GREENFRAME_SECRET_TOKEN}}

```