{"id":21847535,"url":"https://github.com/scribd/job-notification","last_synced_at":"2025-03-21T17:19:59.815Z","repository":{"id":166615277,"uuid":"617012383","full_name":"scribd/job-notification","owner":"scribd","description":"A GitHub Action for sending job notifications","archived":false,"fork":false,"pushed_at":"2024-12-13T01:06:06.000Z","size":37,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-01-26T12:23:55.126Z","etag":null,"topics":["github","managed-by-terraform","service-foundations"],"latest_commit_sha":null,"homepage":"https://github.com/scribd/job-notification","language":null,"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/scribd.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-21T14:27:57.000Z","updated_at":"2024-09-18T19:46:07.000Z","dependencies_parsed_at":null,"dependency_job_id":"ed2c06ee-a4b2-4422-bf84-1cea2ce1e9a8","html_url":"https://github.com/scribd/job-notification","commit_stats":null,"previous_names":["scribd/job-notification"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scribd%2Fjob-notification","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scribd%2Fjob-notification/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scribd%2Fjob-notification/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scribd%2Fjob-notification/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scribd","download_url":"https://codeload.github.com/scribd/job-notification/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244835574,"owners_count":20518263,"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","managed-by-terraform","service-foundations"],"created_at":"2024-11-27T23:18:29.303Z","updated_at":"2025-03-21T17:19:59.792Z","avatar_url":"https://github.com/scribd.png","language":null,"readme":"# job-notification\n\n[![CI](https://github.com/scribd/job-notification/actions/workflows/ci.yml/badge.svg?branch=main\u0026event=push)](https://github.com/scribd/job-notification/actions/workflows/test.yml) [![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)\n\nA GitHub Action for sending job notifications\n\n## Table of contents\n\n- [Quick Start](#quick-start)\n- [Advanced usage](#advanced-usage)\n  - [Customize message](#customize-message)\n  - [Overwrite repository link](#overwrite-repository-link)\n- [Development](#development)\n  - [Testing](#testing)\n  - [Commit messages](#commit-messages)\n- [Maintainers](#maintainers)\n\n## Quick Start\n\n```yaml\nsteps:\n  - name: Send notification \n    if: always() # Always send notification regardless of the job status.\n    uses: scribd/job-notification@main\n    with:\n      token: ${{ secrets.SCRIBD_SLACK_GENERIC_TOKEN }}\n      channel: test-release-notification\n```\n\n## Advanced usage\n\n### Customize message\n\nBy default, the notification uses the latest commit message. You can overwrite that using the `message` field. \n\nTo test the message formating, use the [Block Kit Builder](https://app.slack.com/block-kit-builder/).\n\n```yaml\nsteps:\n  - name: Send notification \n    if: always()\n    uses: scribd/job-notification@main\n    with:\n      token: ${{ secrets.SCRIBD_SLACK_GENERIC_TOKEN }}\n      channel: test-release-notification\n      message: \u003chttps://github.com/${{ github.repository }}|Released update\u003e\n```\n\n### Overwrite repository and status\n\nBy default, the notification links to the repository that triggers the job. You can overwrite that using the `repository` field, which is useful for managing the release for multiple repositories in one place. See [scribd-api-proto](https://github.com/scribd/scribd-api-proto) for example.\n\n```yaml\n# Example: release.yml in scribd-api-proto\nsteps:\n  - name: Send notification \n    if: always()\n    uses: scribd/job-notification@main\n    with:\n      token: ${{ secrets.SCRIBD_SLACK_GENERIC_TOKEN }}\n      channel: test-release-notification\n      repository: scribd/scribd-api-ruby\n```\nAdditionally, `status` can be set explicitly to `success`, `failure` or another custom value to override the default behavior of using status of the job calling this action.\n\n```yaml\nsteps:\n  - name: Send notification\n    uses: scribd/job-notification@main\n    with:\n      token: ${{ secrets.SCRIBD_SLACK_GENERIC_TOKEN }}\n      channel: test-release-notification\n      status: warning\n```\n\n## Development\n\n### Testing\n\nYou can test your changes by pushing them to a branch, which will trigger the [test](.github/workflows/test.yml) workflow to send the notifications to the [test-release-notification](https://scribd.slack.com/archives/C04U68KR6CU) channel on Slack.\n\n### Commit messages\n\nPlease follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) and [Angular commit message guidelines](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines) for writing commit messages.\n\n## Maintainers\n\nMade with ❤️ by the Service Foundations teams.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscribd%2Fjob-notification","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscribd%2Fjob-notification","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscribd%2Fjob-notification/lists"}