update to v1.1.0 in Readme (#48)

karpikpl · Jan 7, 2025 · 230c750 · 230c750
1 parent 6760196
commit 230c750
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -8,6 +8,9 @@ GitHub Action that annotates code with pylint linting results captured using
 
 ## Usage
 
+Recommended usage with
+[Pylint action](https://github.com/marketplace/actions/pylint-annotation-action)
+
 ### Basic
 
 You need to add permissions for this tool.
@@ -19,7 +22,7 @@ permissions:
 ```
 
 ```yaml
-uses: karpikpl/pylint-annotation-action@1.0.0
+uses: karpikpl/pylint-annotation-action@1.1.0
 with:
   lint-file: pylint.json
   pylint-result-code: 0
@@ -30,7 +33,8 @@ with:
 
 ### `head-sha`
 
-**Required** SHA of the commit to annotate.
+**Optional** SHA of the commit to annotate. Defaults to `github.sha` - current
+commit.
 
 ### `lint-file`
 

diff --git a/action.yml b/action.yml
@@ -14,6 +14,7 @@ inputs:
     default: 0
   head-sha:
     description: 'SHA of the commit to annotate.'
+    default: '${{ github.sha }}'
     required: true
   repo-owner:
     description: 'The repo owner.'