{"id":15018141,"url":"https://github.com/probot/example-github-action","last_synced_at":"2025-04-13T09:37:21.336Z","repository":{"id":37657374,"uuid":"320721725","full_name":"probot/example-github-action","owner":"probot","description":"Probot \u0026 GitHub Action example","archived":false,"fork":false,"pushed_at":"2024-10-28T03:08:58.000Z","size":1171,"stargazers_count":34,"open_issues_count":4,"forks_count":25,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-10-29T15:51:45.262Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/probot.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2020-12-12T01:19:44.000Z","updated_at":"2024-10-28T03:08:35.000Z","dependencies_parsed_at":"2023-02-10T00:31:01.578Z","dependency_job_id":"8d3fb748-ce11-4af2-9a03-3bcb77a41e33","html_url":"https://github.com/probot/example-github-action","commit_stats":{"total_commits":163,"total_committers":7,"mean_commits":"23.285714285714285","dds":0.4785276073619632,"last_synced_commit":"fcb0ab5bf389f100a614e55b5100d5bc7a479442"},"previous_names":[],"tags_count":9,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/probot%2Fexample-github-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/probot%2Fexample-github-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/probot%2Fexample-github-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/probot%2Fexample-github-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/probot","download_url":"https://codeload.github.com/probot/example-github-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248691580,"owners_count":21146394,"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-09-24T19:51:30.283Z","updated_at":"2025-04-13T09:37:21.305Z","avatar_url":"https://github.com/probot.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Probot \u0026 GitHub Action example\n\n\u003e This repository is an example of how to create a GitHub Action using Probot\n\n[![Build Status](https://github.com/probot/example-github-action/workflows/Test/badge.svg)](https://github.com/probot/example-github-action/actions)\n\nIf you build a GitHub Action using Probot, we recommend you watch this repository as we will keep updating it implementing best practises and new APIs.\n\n## Usage\n\nYou can use the action from this example repository:\n\n```yml\nname: Say Hello World\non:\n  issues:\n    types:\n      - opened\n\njobs:\n  sayHelloWorld:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: probot/example-github-action@v1\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n```\n\nSee the action in ... action [#1](https://github.com/probot/example-github-action/issues/1)\n\nAlternatively, you can pass the token with `with:`\n\n```yml\n- uses: probot/example-github-action@v1\n  with:\n    token: ${{ secrets.GITHUB_TOKEN }}\n    # or\n    # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n```\n\n## Configuration\n\nGitHub App authentication via `APP_ID`/`PRIVATE_KEY` is not supported. Only token authentication is supported by setting `GITHUB_TOKEN`.\n\nNote that the `LOG_LEVEL` environment variable is ignored. Debug logs are not logged by default in GitHub Actions, but can be enabled by creating a `ACTIONS_STEP_DEBUG` repository secret and setting it to 1.\n\n## How it works\n\nThe Probot application function is defined in [`app.js`](app.js).\n\nThe Action will run the [`index.js`](index.js) file which verifies the required environment variables are set, loads the Probot application function and then receives the event from the file system.\n\n**Important:** GitHub Actions do not automatically install npm dependencies. Because you need to use `@probot/github-action` and probably other external dependencies, you need to bundle your app into a single file and reference that file as entry `run.mains` in your `action.yml` file. You can use [ncc](https://github.com/vercel/ncc) for that.\n\nThis repository is continuously publishing new versions to the special `v1` branch using [`semantic-release`](github.com/semantic-release/semantic-release). See [package.json](package.json). Relevant bits are\n\n1. `\"build\": \"ncc build index.js -o dist\"` script - bundle the app into `dist/index.js`\n2. `\"release\"` - configure publishing from the `\"main\"` branch, and configure the `git` plugin to add a commit after publishing\n\nThe other relevant bit is [`.github/workflows/release.yml`](.github/workflows/release.yml), which is run on each push to the default branch (`main`). It installs all dependencies, runs the `build` script, runs semantic-release which creates the GitHub release based on semantic commit message conventions (`fix: ...`, `feat: ...`) and commits the `dist/index.js` file. Then it pushes the changes to the `v1` branch, so that users will always get the latest version when referencing `probot/exmaple-github-action@v1`. If there should ever be a breaking change, we would change the publish branch to `v2`, etc.\n\n## License\n\n[ISC](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprobot%2Fexample-github-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprobot%2Fexample-github-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprobot%2Fexample-github-action/lists"}