Skip to content

Verified commit

Actions
GitHub Action to create verified commits
v2.0.0
Latest
Star (18)

Commit

✅ Create a verified commit with GitHub Actions

code style: prettier

About

This action allows you to create a commit with GitHub Actions. Commits created with this actions will be marked as verified.

image

Usage

In your workflow, to commit a file ./myfile, include a step like this:

    - name: Commit file
      uses: swinton/[email protected]
      env:
        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      with:
        files: |
          myfile
        commit-message: Committing ./myfile
        ref: refs/heads/my-branch

Note, the GH_TOKEN environment variable is required, since commits are created using GitHub's Git Database API.

To commit multiple files in a single commit, pass each file on a newline to the files input:

    - name: Commit files
      uses: swinton/[email protected]
      env:
        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      with:
        files: |
          path/to/myfile1
          path/to/myfile2
          path/to/myfile3
        commit-message: Committing files
        ref: refs/heads/my-branch

Inputs

The following inputs are required:

  • files: Newline-separated list of files to be committed, relative to root of repository, e.g.
    myfile1
    myfile2
    ...
    myfileN
  • commit-message: Commit message to be used, e.g. Add ./myfile
  • ref: Fully qualified name of reference to be updated with commit, e.g. refs/heads/production. This reference must already exist. Defaults to the repository's default branch ref.

Outputs

This action provides the following outputs:

  • commit-sha: SHA of created commit

Verified commit is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

GitHub Action to create verified commits
v2.0.0
Latest

Verified commit is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.