Skip to content
/ commit Public

✅ GitHub Action to create verified commits

License

Notifications You must be signed in to change notification settings

swinton/commit

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace
This branch is 1 commit ahead of main.

Folders and files

NameName
Last commit message
Last commit date
Dec 19, 2020
Dec 11, 2020
Dec 14, 2020
Dec 14, 2020
Dec 11, 2020
Dec 10, 2020
Dec 7, 2020
Dec 4, 2020
Dec 20, 2020
Dec 10, 2020
Dec 11, 2020
Dec 13, 2020
Dec 13, 2020
Oct 27, 2023
Oct 27, 2023
Dec 12, 2020
Dec 4, 2020

Repository files navigation

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