Merge pull request #4 from KevinDeJong-TomTom/fix/add-commisery-action

fix: add commisery_action.py to the Dockerfile
KevinDeJong-TomTom · Sep 12, 2020 · 6983abd · 6983abd
2 parents 27a4a7f + 3e636d1
commit 6983abd
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 4 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -24,6 +24,10 @@ RUN apt-get update \
 # Install commisery
 RUN pip install commisery==0.1.1 PyGithub==1.53 Click==7.1.2
 
+# Copy action
+COPY commisery_action.py /commisery_action.py
+RUN chmod +x /commisery_action.py
+
 # Prepare entrypoint
 COPY entrypoint.sh /entrypoint.sh
 RUN chmod +x /entrypoint.sh

diff --git a/README.rst b/README.rst
@@ -37,8 +37,8 @@ The workflow, usually declared in `.github/workflows/build.yml`, looks like:
             token: ${{ secrets.GITHUB_TOKEN }}
             pull_request: ${{ github.event.number }}
 
-Secrets
-^^^^^^^
+Inputs
+^^^^^^
 
 - **token**: GitHub Token provided by GitHub, see `Authenticating with the GITHUB_TOKEN`_
 - **pull_request**: Pull Request number, provided by the `GitHub context`_.

diff --git a/action.yml b/action.yml
@@ -13,17 +13,18 @@
 # limitations under the License.
 
 name: 'Commisery'
+author: 'Kevin de Jong'
 description: >
   Scan your commits in your Pull Request against the Conventional
   Commits standard using Commisery
 
 inputs:
   token: 
-    description: 'GitHub token used to access GitHub'
+    description: 'GitHub token used to access GitHub (eg. secrets.GITHUB_TOKEN)'
     required: true
 
   pull_request:
-    description: 'Pull Request number'
+    description: 'Pull Request number (eg. github.event.number)'
     required: true
 
 runs: