{"id":16058759,"url":"https://github.com/ryancyq/github-signed-commit","last_synced_at":"2025-08-13T14:32:51.129Z","repository":{"id":255206323,"uuid":"847040760","full_name":"ryancyq/github-signed-commit","owner":"ryancyq","description":"🖋️ Create a signed commit with GitHub Actions.","archived":false,"fork":false,"pushed_at":"2024-10-24T09:05:42.000Z","size":589,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-25T06:04:31.292Z","etag":null,"topics":["commit-message","commits","continous-integration","git","github","github-actions","gpg-signature","signed-commits","tagging","tags","verified-commits"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/ryancyq.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2024-08-24T17:16:27.000Z","updated_at":"2024-10-24T09:04:09.000Z","dependencies_parsed_at":"2024-10-27T16:17:49.744Z","dependency_job_id":"ce665065-c85f-443d-b706-80e02d9466b2","html_url":"https://github.com/ryancyq/github-signed-commit","commit_stats":null,"previous_names":["ryancyq/signed-commits"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryancyq%2Fgithub-signed-commit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryancyq%2Fgithub-signed-commit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryancyq%2Fgithub-signed-commit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryancyq%2Fgithub-signed-commit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ryancyq","download_url":"https://codeload.github.com/ryancyq/github-signed-commit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229767191,"owners_count":18121042,"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":["commit-message","commits","continous-integration","git","github","github-actions","gpg-signature","signed-commits","tagging","tags","verified-commits"],"created_at":"2024-10-09T03:40:32.853Z","updated_at":"2025-08-13T14:32:50.802Z","avatar_url":"https://github.com/ryancyq.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# :fountain_pen: Create **signed** commits with GitHub Actions\n\n[![CI][ci_badge]][ci_workflows]\n[![Coverage][coverage_badge]][coverage]\n[![Maintainability][maintainability_badge]][maintainability]\n\nLearn more about [commit signature](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) on GitHub.\n\n## Features\n\nWorks with the [GitHub GraphQL API](https://docs.github.com/en/graphql).\n\n- Uses the Git CLI to detect file changes against the file paths provided in the input.\n- Uses a single GraphQL mutation request to upload all blob file content.\n- Supports glob patterns for file paths.\n- Push tag to the new/current commit on a branch.\n\n## Known Limitation\nDoes not support HTTP request streaming, so the action runner will consume more memory during execution when uploading large blob files.\n\n## Usage\nIn your workflow, to commit your files, configure a step as follows:\n\n```yaml\njobs:\n  \u003cjob-id\u003e:\n    permissions:\n      contents: write # grant secrets.GITHUB_TOKEN permission to push file changes\n  \n    - name: Commit file\n      uses: ryancyq/github-signed-commit@v1\n      env:\n        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n      with:\n        files: |\n          path/to/myfile1\n          path/to/*.md\n          path/to/**/*.js\n        commit-message: Committing files\n```\n\n```yaml\njobs:\n  \u003cjob-id\u003e:\n    permissions:\n      contents: write # grant secrets.GITHUB_TOKEN permission to push file changes\n  \n    - name: Commit file\n      uses: ryancyq/github-signed-commit@v1\n      env:\n        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n      with:\n        files: path/to/myversion\n        commit-message: Release new version\n        tag: v1.0.3\n```\n\nNote: The `GH_TOKEN` environment variable is **required** for GitHub API request authentication.\n\n## Inputs\n| Input | Required | Description |\n| :--- | :---: | :---  |\n| `files` | **YES** | Multi-line string of file paths to be committed, relative to the current workspace.|\n| `workspace` | **NO** | Directory containing files to be committed. **DEFAULT:** GitHub workspace directory (root of the repository). |\n| `commit-message` | **YES** | Commit message for the file changes. |\n| `repository` | **NO** | Repository name including owner (e.g. owner/repo). **DEFAULT:** Workflow triggered repository |\n| `branch-name` | **NO** | Branch to commit, it must already exist in the remote. **DEFAULT:** Workflow triggered branch |\n| `branch-push-force` | **NO** | `--force` flag when running `git push \u003cbranch-name\u003e`. |\n| `tag` | **NO** | Push tag for the new/current commit. |\n| `tag-only-if-file-changes` | **NO** | Push tag for new commit only when file changes present. **DEFAULT:** true |\n\n## Outputs\n| Output | Description |\n| :--- | :--- |\n| `commit-sha` | Full SHA of the signed commit. |\n| `tag` | Tag of the signed commit. |\n\n[ci_badge]: https://github.com/ryancyq/github-signed-commit/actions/workflows/ci.yml/badge.svg\n[ci_workflows]: https://github.com/ryancyq/github-signed-commit/actions/workflows/ci.yml\n[coverage_badge]: https://codecov.io/gh/ryancyq/github-signed-commit/graph/badge.svg?token=KZTD2F2MN2\n[coverage]: https://codecov.io/gh/ryancyq/github-signed-commit\n[maintainability_badge]: https://api.codeclimate.com/v1/badges/0de9dbec270ca85719c6/maintainability\n[maintainability]: https://codeclimate.com/github/ryancyq/github-signed-commit/maintainability","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryancyq%2Fgithub-signed-commit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fryancyq%2Fgithub-signed-commit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryancyq%2Fgithub-signed-commit/lists"}