1
0
mirror of https://github.com/benjlevesque/short-sha.git synced 2025-12-06 09:47:49 +01:00
Files
short-sha/README.md
Benjamin LEVESQUE da73c6c771 fix typo
2020-05-02 16:37:35 +02:00

33 lines
736 B
Markdown

# Short SHA
`short-sha` is a GitHub Action than provides an output `sha` with the shortened commit SHA.
## Usage
```yaml
name: 'build-test'
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: benjlevesque/short-sha@v1.1
id: short-sha
with:
length: 6
- run: echo $SHA
env:
SHA: ${{ steps.short-sha.outputs.sha }}
- run: echo $SHA
env:
SHA: ${{ env.SHA }}
```
## Options
| Name | Required | Default | Description |
| ------ | -------- | ------- | ---------------------------------------- |
| length | `false` | 8 | the expected length of the shortened SHA |