{"id":25399156,"url":"https://github.com/pradumnasaraf/pullprompt","last_synced_at":"2025-10-25T11:34:57.524Z","repository":{"id":275474924,"uuid":"926176477","full_name":"Pradumnasaraf/pullprompt","owner":"Pradumnasaraf","description":"PullPrompt is a GitHub Action that comments on a Pull Request with a message generated from a user-given prompt. Under the hood, it uses Google’s Gemini API to generate the text.","archived":false,"fork":false,"pushed_at":"2025-02-03T18:41:21.000Z","size":303,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-10T10:55:52.091Z","etag":null,"topics":["actions","github-actions","google-gemini","javascript","nodejs"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/pullprompt","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Pradumnasaraf.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["eddiejaoude"]}},"created_at":"2025-02-02T18:22:21.000Z","updated_at":"2025-02-05T11:37:12.000Z","dependencies_parsed_at":"2025-02-02T19:44:32.505Z","dependency_job_id":null,"html_url":"https://github.com/Pradumnasaraf/pullprompt","commit_stats":null,"previous_names":["pradumnasaraf/pullprompt"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pradumnasaraf%2Fpullprompt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pradumnasaraf%2Fpullprompt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pradumnasaraf%2Fpullprompt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pradumnasaraf%2Fpullprompt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Pradumnasaraf","download_url":"https://codeload.github.com/Pradumnasaraf/pullprompt/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239069975,"owners_count":19576466,"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":["actions","github-actions","google-gemini","javascript","nodejs"],"created_at":"2025-02-15T23:29:46.201Z","updated_at":"2025-10-25T11:34:57.516Z","avatar_url":"https://github.com/Pradumnasaraf.png","language":"JavaScript","funding_links":["https://github.com/sponsors/eddiejaoude"],"categories":[],"sub_categories":[],"readme":"[![release][release-badge]][release]\n[![releases-ci][releases-ci-badge]][releases-ci]\n[![build-ci][build-ci-badge]][build-ci]\n[![actions-marketplace][actions-marketplace-badge]][actions-marketplace]\n\n## About (PullPrompt)\n\n**PullPrompt** comments on a Pull Request with a message generated from a user-given prompt. Under the hood, it uses Google’s Gemini API to generate the text.\n\n## Features\n\n- **Model Selection**: Choose from a variety of models to generate the text.\n- **Model Temperature**: Set the temperature of the model to control the creativity of the text.\n- **Word Limit and Language**: Set the word limit and language of the generated text.\n\n## Usage  \n\nThe Action multiple inputs, some are required and some are optional:  \n\n1. **`github-token`** (Required) – The GitHub token used for authentication.  \n   *\"Share an open-source tip in 2 to 3 lines to help developers improve their workflow.\"* You can find this in the `action.yml` file.  \n2. **`gemini-api-key`** (Required) – The Gemini API key used for authentication and text generation. You can obtain it from the [Gemini API](https://ai.google.dev/gemini-api/docs/api-key) page.  \n3. **`user-prompt`** (Optional) – The prompt used to generate the text. The default is:  \n4. **`gemini-model`** (Optional) – The model used to generate the text. The default is: `gemini-2.5-pro`. We can use other Gemini models like `gemini-2.5-flash`, `gemini-2.5-flash-lite`, `gemini-2.0-flash`, `gemini-2.0-flash-lite`. A complete list of models can be found [here](https://ai.google.dev/gemini-api/docs/models/gemini).\n5. **`word-limit`** (Optional) – The word limit for the generated text. The default is 200.\n6. **`output-language`** (Optional) – The language of the generated text. The default is `english`.\n7. **`model-temp`** (Optional) – The temperature of the model. The default is 0.5. We can set the temperature between 0.1 to 1.0. The lower the temperature, the more deterministic the model will be. The higher the temperature, the more creative the model will be.\n\n### **Setting up the API Key**  \nOnce you have the API key, add it to your repository secrets:  \n1. Go to **Repository Settings** → **Secrets** → **Actions**.  \n2. Click **New Repository Secret**.  \n3. Name it **`GEMINI_API_KEY`** and paste the API key as the value.  \n\n### **Event Trigger**  \nPullPrompt only works on **pull request events**. It will not trigger on any other event.  \n\n```yaml\non:\n  pull_request: # Works only on pull requests\n```\n\n### **Example Workflow**  \nBelow is an example of how to use PullPrompt in a GitHub Actions workflow:\n\n\u003e [!IMPORTANT]  \n\u003e Before using the below code, check the `pullprompt` action version in the `uses` field from the [GitHub Marketplace](https://github.com/marketplace/actions/pullprompt) for the latest version.\n\n```yaml\nname: PullPrompt\n\non:\n  pull_request: # Works only on pull requests\n\njobs:\n  pull_prompt:\n    runs-on: ubuntu-latest\n\n    permissions:\n      contents: read # Required for reading files\n      pull-requests: write # Required for commenting on PRs\n\n    steps:\n      - name: Checkout the code\n        uses: actions/checkout@v4\n\n      - name: Running PullPrompt\n        uses: Pradumnasaraf/pullprompt@v1.4.0\n        with:\n          github-token: ${{ secrets.GITHUB_TOKEN }} # Required\n          gemini-api-key: ${{ secrets.GEMINI_API_KEY }} # Required\n          user-prompt: \"How to become a better developer?\" # Optional\n          gemini-model: \"gemini-2.5-pro\" # Optional\n          output-language: \"spanish\" # Optional\n          word-limit: 250 # Optional\n          model-temp: 0.5 # Optional\n```\n\n## Example  \n\n![en](https://github.com/user-attachments/assets/929d1aaa-4bed-4a21-b2bc-f809c4f7960d)\n\n![jp](https://github.com/user-attachments/assets/94d69c65-5d6d-459a-8b5c-0750ccb3edbe)\n\n## Contributing  \n\nIf you have suggestions for improving PullPrompt or want to report a bug, feel free to open an issue! We welcome all contributions.  \n\nFor more details, check out the [Contributing Guide](CONTRIBUTING.md).  \n\n## License  \n\nThis project is licensed under the [GNU General Public License v3.0](LICENSE).  \n\n## Security  \n\nFor information on reporting security vulnerabilities, please refer to the [Security Policy](SECURITY.md).  \n\n[release]: https://github.com/Pradumnasaraf/pullprompt/releases\n[release-badge]: https://img.shields.io/github/v/release/Pradumnasaraf/pullprompt\n[releases-ci]: https://github.com/Pradumnasaraf/pullprompt/actions/workflows/releases.yml\n[releases-ci-badge]: https://github.com/Pradumnasaraf/pullprompt/actions/workflows/releases.yml/badge.svg\n[build-ci]: https://github.com/Pradumnasaraf/pullprompt/actions/workflows/ci.yml\n[build-ci-badge]: https://github.com/Pradumnasaraf/pullprompt/actions/workflows/ci.yml/badge.svg\n[actions-marketplace]: https://github.com/marketplace/actions/pullprompt\n[actions-marketplace-badge]: https://img.shields.io/badge/marketplace-PullPrompt-blue?\u0026logo=github\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpradumnasaraf%2Fpullprompt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpradumnasaraf%2Fpullprompt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpradumnasaraf%2Fpullprompt/lists"}