{"id":21455539,"url":"https://github.com/hookdeck/github-action-example","last_synced_at":"2026-03-19T20:29:47.096Z","repository":{"id":118550365,"uuid":"531584161","full_name":"hookdeck/github-action-example","owner":"hookdeck","description":null,"archived":false,"fork":false,"pushed_at":"2022-09-01T16:30:32.000Z","size":5,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-23T13:13:48.673Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/hookdeck.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2022-09-01T15:44:04.000Z","updated_at":"2022-10-28T17:33:22.000Z","dependencies_parsed_at":null,"dependency_job_id":"2d58551f-c2f6-41e5-b913-c9e1623b33e6","html_url":"https://github.com/hookdeck/github-action-example","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/hookdeck%2Fgithub-action-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hookdeck%2Fgithub-action-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hookdeck%2Fgithub-action-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hookdeck%2Fgithub-action-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hookdeck","download_url":"https://codeload.github.com/hookdeck/github-action-example/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243966076,"owners_count":20375993,"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-23T05:12:34.064Z","updated_at":"2026-01-03T06:49:19.437Z","avatar_url":"https://github.com/hookdeck.png","language":null,"readme":"# Hookdeck GitHub Action Example\n\n[slack-badge]: https://img.shields.io/badge/Slack-Hookdeck%20Developers-blue?logo=slack\n\n[![slack-badge]](https://join.slack.com/t/hookdeckdevelopers/shared_invite/zt-yw7hlyzp-EQuO3QvdiBlH9Tz2KZg5MQ)\n\nThis repo contains an example of using the Hookdeck CLI in a GitHub action.\n\n## Prerequisites\n\n### Hookdeck CLI Token\n\nYou must first get a CLI token and set it as a repository or organization\nsecret.\n\nFollow the [CLI installation instructions][hookdeck-cli-install] to get a local\ncopy of the CLI and execute the following command:\n\n```shell\nhookdeck login --config hookdeck.toml\n```\n\nNow examine the config file:\n\n```shell\ncat hookdeck.toml\n```\n\nIt will look something like this:\n\n```toml\n[default]\n  api_key = \"1234567910...\"\n  client_id = \"cli_123\"\n  device_name = \"MacBook-Pro.local\"\n  display_name = \"Lee Trout\"\n  team_name = \"Demo\"\n```\n\nCopy the token from the line `api_key` and save it as a [secret in\nGitHub][github-secret].\n\nFor this example it is named `HOOKDECK_CLI_KEY`\n\nDelete the config file:\n\n```shell\nrm hookdeck.toml\n```\n\n## Create the action\n\nSee the [example workflow][example-workflow] for setting up the action.\n\nYou will see that I use a secret for my Hookdeck connection source URL since\nthis is a public repository but it is not necessary to make it a secret if your\nrepository is private.\n\n[example-workflow]: .github/workflows/example.yml\n[github-secret]:\n    https://docs.github.com/en/actions/security-guides/encrypted-secrets\n[hookdeck-cli-install]: https://hookdeck.com/cli#installation\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhookdeck%2Fgithub-action-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhookdeck%2Fgithub-action-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhookdeck%2Fgithub-action-example/lists"}