[!important] Incubation Project : This project is an incubation project being run inside the Green Software Foundation; as such, we DON’T recommend using it in any critical use case. Incubation projects are experimental, offer no support guarantee, have minimal governance and process, and may be retired at any moment. This project may one day Graduate, in which case this disclaimer will be removed.

carbon_ci_pipeline_tooling

Calculate the carbon emissions of an application via static analysis of the code and any infrastructure as code files in a repository.

Scope

This project aims to build the capability to calculate the carbon emissions of an application via static analysis of the code and any infrastructure as code files in a repository.

This tooling covers the pipeline from a git commit, up to deployment, in a typical continuous integration/continuous deployment process.

Considered approaches include:

1. A GitHub Action to run during deployment
2. A GitHub Action to run on a pull request
3. A Pre-commit application to run every time a commit is made

Appointments

• Fergus Kidd (Avanade)

Solutions Referenced

• GitHub Actions for Azure
• GitHub Actions for .NET
• Create a VM
• Deploy an ARM template
• Git Hooks
• Electricitymap API
• Creating a Docker Action

Documentation

Limited documentation has been created, as this is not yet an approved GSF deliverable. Further documentation will be added to the docs folder, along with setup instructions.

Working with the project

Contributions are welcome. See information on contributing.

If you're happy to follow these guidelines, then check out the getting started guide.

This project is part of the Green Software Foundation. It is open to any member of the Foundation, for more details regarding the foundation and the application form to join please go to https://greensoftware.foundation.

Contributing and our ways of working

1. Create a new Issue
2. Discuss Issue with group --> Create PR if required
3. PR to be submitted against the DEV feature branch
4. PR discussed with the group. If agreed, the chair and maintainer will merge into DEV Feature branch

5. See The Way we Work for futher details.

Resources

• Slack Channel (Members Only)

Licensing

carbon_ci_pipeline_tooling is available under the MIT Licence.

Copyright

Open Source Innovation WG projects are copyrighted under Creative Commons Attribution 4.0.

Patent

No Patent License. No patent licenses are granted for the Draft Deliverables or Approved Deliverables developed by this Working Group.

Dataset

CDLA-Permissive-1.0

Help

[email protected]