{"id":19399882,"url":"https://github.com/pipe-cd/actions-event-register","last_synced_at":"2025-02-24T23:25:36.877Z","repository":{"id":51273416,"uuid":"367287926","full_name":"pipe-cd/actions-event-register","owner":"pipe-cd","description":"A GitHub action for registering Events to PipeCD","archived":false,"fork":false,"pushed_at":"2024-11-07T09:17:54.000Z","size":17,"stargazers_count":13,"open_issues_count":0,"forks_count":3,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-02-11T11:48:11.105Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://pipecd.dev/docs/user-guide/event-watcher","language":null,"has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pipe-cd.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":"2021-05-14T07:44:23.000Z","updated_at":"2024-11-07T08:51:41.000Z","dependencies_parsed_at":"2025-01-07T11:36:04.806Z","dependency_job_id":"16218ee1-f399-4d5d-9f97-0281dba626f2","html_url":"https://github.com/pipe-cd/actions-event-register","commit_stats":{"total_commits":7,"total_committers":3,"mean_commits":"2.3333333333333335","dds":0.2857142857142857,"last_synced_commit":"31411d95867afc081cebc4a4b465ab438213752c"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pipe-cd%2Factions-event-register","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pipe-cd%2Factions-event-register/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pipe-cd%2Factions-event-register/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pipe-cd%2Factions-event-register/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pipe-cd","download_url":"https://codeload.github.com/pipe-cd/actions-event-register/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240572722,"owners_count":19822710,"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":[],"created_at":"2024-11-10T11:12:03.520Z","updated_at":"2025-02-24T23:25:36.847Z","avatar_url":"https://github.com/pipe-cd.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# actions-event-register\nA GitHub action for registering Events to PipeCD. This action makes it easier to use the Event watcher feature in a GitHub Actions workflow.\nFor Event watcher, see: [the documentation](https://pipecd.dev/docs/user-guide/event-watcher).\n\n## Inputs\n\n### `api-address`\n\n**Required**: gRPC address to the PipeCD api server.\n\n### `api-key`\n\n**Required**: API key to which the READ_WRITE role is attached.\n\n### `event-name`\n\n**Required**: The name of Event.\n\n### `data`\n\n**Required**: The string value of event data.\n\n### `labels`\n\n**Optional**: The comma-separated list of labels for the event. Format: key=value,key2=value2\n\n### `contexts`\n\n**Optional**:　Require pipectl \u003e= v0.49.3. The comma-separated list of contexts for the event. Format: key=value,key2=value2\n\n### `pipectl-version`\n\n**Optional**: The version of pipectl command. Release versions: https://github.com/pipe-cd/pipecd/releases\n\n## Examples\nAt first, you need to create new secrets with the name `PIPECD_API_ADDRESS` and `PIPECD_API_KEY`.\nThe value of `PIPECD_API_ADDRESS` must be in a format like \"host:443\" because the communication is done via gRPC.\n\n### Using the commit SHA as data\n\n```yaml\nname: \"Register an event on PipeCD\"\non:\n  push:\n    branches:\n    - main\njobs:\n  register-event:\n    runs-on: ubuntu-latest\n    steps:\n    - uses: pipe-cd/actions-event-register@v1\n      with:\n        api-address: ${{ secrets.PIPECD_API_ADDRESS }}\n        api-key: ${{ secrets.PIPECD_API_KEY }}\n        event-name: image-update\n        labels: app=foo,env=dev\n        data: ${{ github.sha }}\n        pipectl-version: v0.41.3\n```\n\n### Using git tag as data\n\n```yaml\nname: \"Register an event on PipeCD\"\non:\n  push:\n    branches:\n    - main\njobs:\n  register-event:\n    runs-on: ubuntu-latest\n    steps:\n    - uses: actions/checkout@v2\n      with:\n        fetch-depth: 0\n    - run: echo \"TAG=`git describe --tags`\" \u003e\u003e $GITHUB_ENV\n    - uses: pipe-cd/actions-event-register@v1\n      with:\n        api-address: ${{ secrets.PIPECD_API_ADDRESS }}\n        api-key: ${{ secrets.PIPECD_API_KEY }}\n        event-name: image-update\n        labels: app=foo,env=dev\n        data: ${{ env.TAG }}\n        pipectl-version: v0.41.3\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpipe-cd%2Factions-event-register","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpipe-cd%2Factions-event-register","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpipe-cd%2Factions-event-register/lists"}