PR validation

Author: 2m

.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+---
+name: ci
+
+on:  # yamllint disable-line rule:truthy
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  validation:
+    runs-on: ubuntu-latest
+    name: Validate a Pull Request
+    steps:
+      - uses: actions/checkout@v1
+
+      - name: Run yamllint
+        uses: ibiqlik/[email protected]
+
+      - name: Run ShellCheck
+        uses: ludeeus/action-shellcheck@master

.github/workflows/release-drafter.yml

@@ -1,6 +1,6 @@
 name: Release Drafter
 
-on:
+on:  # yamllint disable-line rule:truthy
   push:
     branches:
       - master

.yamllint

@@ -0,0 +1,6 @@
+---
+extends: default
+
+rules:
+  # Disable requirement for `---` at the beginning of each file
+  document-start: disable

README.md

@@ -14,7 +14,8 @@ This assumption is made so this action works well with [aurpublish].
 
 ### `pkgname`
 
-**Required** The `pkgname` of the package to be validated.
+**Required** Path to DIRECTORY where the PKGBUILD file is.
+Assumes the directory is the name of package, ie /path/to/pkgname/'
 
 ## Example usage
 

action.yml

@@ -1,28 +1,34 @@
-name: 'Arch Linux PKGBUILD builder action'
-description: 'Builds an validates PKGBUILD definition'
+name: Arch Linux PKGBUILD builder action
+description: Builds an validates PKGBUILD definition
 
 branding:
-  icon: 'triangle'
-  color: 'blue'
+  icon: triangle
+  color: blue
 
 inputs:
   pkgname:
-    description: 'Path to DIRECTORY where the PKGBUILD file is. Assumes the directory is the name of package, ie /path/to/pkgname/'
+    description: >-
+      Path to DIRECTORY where the PKGBUILD file is.
+      Assumes the directory is the name of package, ie /path/to/pkgname/
     required: true
   target:
-    description: 'Validation target. Can be one of: "pkgbuild", "srcinfo"'
+    description: >-
+      Validation target.
+      Can be one of: "pkgbuild", "srcinfo", "run"
     required: true
     default: 'pkgbuild'
   command:
-    description: 'Command to run after package installation'
+    description: >-
+      Command to run after package installation.
+      Used when target=run
     required: false
   debug:
-    description: 'Turns debugging on'
+    description: Turns debugging on
     required: false
 
 runs:
-  using: 'docker'
-  image: 'Dockerfile'
+  using: docker
+  image: Dockerfile
   args:
     - ${{ inputs.target }}
     - ${{ inputs.pkgname }}