https://github.com/rlespinasse/git-commit-data-action

Action to expose git commit info
https://github.com/rlespinasse/git-commit-data-action

commit git github-actions hacktoberfest

Last synced: 6 days ago
JSON representation

Action to expose git commit info

• Host: GitHub
• URL: https://github.com/rlespinasse/git-commit-data-action
• Owner: rlespinasse
• License: mit
• Created: 2020-05-03T20:07:32.000Z (over 4 years ago)
• Default Branch: v1.x
• Last Pushed: 2024-10-27T06:03:51.000Z (2 months ago)
• Last Synced: 2024-12-25T22:07:59.817Z (13 days ago)
• Topics: commit, git, github-actions, hacktoberfest
• Language: Shell
• Homepage:
• Size: 127 KB
• Stars: 41
• Watchers: 3
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-actions - Expose Git Commit Data As Environment Variables
• fucking-awesome-actions - Expose Git Commit Data As Environment Variables
• awesome-workflows - Expose Git Commit Data As Environment Variables

README

        
# Git commit data action

This action exposes git commit data.

- **GIT_COMMIT_SHA** expose `commit hash`

- **GIT_COMMIT_SHORT_SHA** expose `abbreviated commit hash`

- **GIT_COMMIT_AUTHOR** expose `Author name `

- **GIT_COMMIT_AUTHOR_NAME** expose `Author name`

- **GIT_COMMIT_AUTHOR_EMAIL** expose `[email protected]`

- **GIT_COMMIT_COMMITTER** expose `Committer name `

- **GIT_COMMIT_COMMITTER_NAME** expose `Committer name`

- **GIT_COMMIT_COMMITTER_EMAIL** expose `[email protected]`

- **GIT_COMMIT_MESSAGE_SUBJECT** expose `The first line of the commit message`

- **GIT_COMMIT_MESSAGE_SUBJECT_SANITIZED** expose `the-first-line-of-the-commit-message-in-sanitized-way`

- **GIT_COMMIT_MESSAGE_BODY** expose `The body of the commit message`

## Exposed environment variables

```yaml

- name: Expose git commit data

  uses: rlespinasse/git-commit-data-action@v1

- name: Print git commit data

  run: |

    echo "Get commit info"

    echo " - ${{ env.GIT_COMMIT_SHA }}"

    echo " - ${{ env.GIT_COMMIT_SHORT_SHA }}"

    echo "Get author info"

    echo " - ${{ env.GIT_COMMIT_AUTHOR }}"

    echo " - ${{ env.GIT_COMMIT_AUTHOR_NAME }}"

    echo " - ${{ env.GIT_COMMIT_AUTHOR_EMAIL }}"

    echo "Get committer info"

    echo " - ${{ env.GIT_COMMIT_COMMITTER }}"

    echo " - ${{ env.GIT_COMMIT_COMMITTER_NAME }}"

    echo " - ${{ env.GIT_COMMIT_COMMITTER_EMAIL }}"

    echo "Get message info"

    echo " - ${{ env.GIT_COMMIT_MESSAGE_SUBJECT }}"

    echo " - ${{ env.GIT_COMMIT_MESSAGE_SUBJECT_SANITIZED }}"

    echo " - ${{ env.GIT_COMMIT_MESSAGE_BODY }}"

```

## Need other commit data

Feel free to contribute. Check out the [developer guide](DEVELOPER.md)