{"id":13474470,"url":"https://github.com/cirrus-actions/email","last_synced_at":"2025-03-26T21:31:38.277Z","repository":{"id":97569578,"uuid":"164868699","full_name":"cirrus-actions/email","owner":"cirrus-actions","description":"GitHub Action to send emails for Check Suites","archived":true,"fork":false,"pushed_at":"2020-05-20T15:40:17.000Z","size":21,"stargazers_count":11,"open_issues_count":0,"forks_count":10,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-30T07:48:00.542Z","etag":null,"topics":["github-actions"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cirrus-actions.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-09T13:32:32.000Z","updated_at":"2023-01-28T14:28:56.000Z","dependencies_parsed_at":"2023-04-28T09:47:52.900Z","dependency_job_id":null,"html_url":"https://github.com/cirrus-actions/email","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cirrus-actions%2Femail","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cirrus-actions%2Femail/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cirrus-actions%2Femail/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cirrus-actions%2Femail/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cirrus-actions","download_url":"https://codeload.github.com/cirrus-actions/email/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245738687,"owners_count":20664327,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-actions"],"created_at":"2024-07-31T16:01:12.586Z","updated_at":"2025-03-26T21:31:37.940Z","avatar_url":"https://github.com/cirrus-actions.png","language":"Go","funding_links":[],"categories":["Community Resources","Uncategorized"],"sub_categories":["Notifications and Messages","Uncategorized"],"readme":"# Deprecated\n\nNow it's possible to use GitHub Action's own emails by adding the following workflow to your `.github/worflow/email.yml`\n\n```yaml\non:\n  check_suite:\n    type: ['completed']\n\nname: Email about Cirrus CI failures\njobs:\n  continue:\n    name: After Cirrus CI\n    if: github.event.check_suite.app.name == 'Cirrus CI' \u0026\u0026 github.event.check_suite.conclusion != 'success'\n    runs-on: ubuntu-latest\n    steps:\n      - uses: octokit/request-action@v2.x\n        id: get_failed_check_run\n        with:\n          route: GET /repos/${{ github.repository }}/check-suites/${{ github.event.check_suite.id }}/check-runs?status=completed\n          mediaType: '{\"previews\": [\"antiope\"]}'\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n      - run: |\n          echo \"Cirrus CI ${{ github.event.check_suite.conclusion }} on ${{ github.event.check_suite.head_branch }} branch!\"\n          echo \"SHA ${{ github.event.check_suite.head_sha }}\"\n          echo $MESSAGE\n          echo \"##[error]See $CHECK_RUN_URL for details\" \u0026\u0026 false\n        env:\n          CHECK_RUN_URL: ${{ fromJson(steps.get_failed_check_run.outputs.data).check_runs[0].html_url }}\n```\n\n# Send Emails with GitHub Actions\n\n[![Build Status](https://api.cirrus-ci.com/github/cirrus-actions/email.svg)](https://cirrus-ci.com/github/cirrus-actions/email) [![](https://images.microbadger.com/badges/version/cirrusactions/email.svg)](https://microbadger.com/images/cirrusactions/email) [![](https://images.microbadger.com/badges/image/cirrusactions/email.svg)](https://microbadger.com/images/cirrusactions/email)\n\nThis is a simple GitHub action that allows to send emails when a GitHub Check Suite completes. This requires a few \nenvironment variables:\n  * `APP_NAME` - Name of an application for which to send emails for.\n  * `MAIL_FROM` - email address to send emails from.\n  * `MAIL_HOST` - SMTP host to send emails to.\n  * `MAIL_USERNAME` and `MAIL_PASSWORD` - username and password to authorize with the SMTP server.\n  * `GITHUB_TOKEN` - is standard environment variable for GitHub actions.\n  * optional `IGNORED_CONCLUSIONS` to secify conclusions to report. By default only `success` and `neutral` checks are ignored.\n\nNow your action can look liker this in your `.github/main.workflow` workflow file:\n\n```\naction \"Cirrus CI Email\" {\n  uses = \"docker://cirrusactions/email:latest\"\n  env = {\n    APP_NAME = \"Cirrus CI\"\n  }\n  secrets = [\"GITHUB_TOKEN\", \"MAIL_FROM\", \"MAIL_HOST\", \"MAIL_USERNAME\", \"MAIL_PASSWORD\"]\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcirrus-actions%2Femail","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcirrus-actions%2Femail","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcirrus-actions%2Femail/lists"}