Merge pull request #2 from kedro-org/feature/include-hooks

Add include_hooks input for the action

README.md

@@ -56,6 +56,10 @@ This action helps in the automation of a deployment strategy mentioned in [platf
     # The Kedro-project path to build the Kedro-Viz artifacts.
     # Default: '.'
     project_path: ''
+
+    # The flag to include hooks while creating your Kedro-project build artifacts.
+    # Default: false
+    include_hooks: ''
 
     # Your consent to participate in Kedro-Telemetry.
     # Default: true

RELEASE.md

@@ -1,3 +1,9 @@
+# Release 1.1.0:
+
+## Major features and improvements
+
+- Add `include_hooks` input for the action
+
 # Release 1.0.0:
 
 This is an initial release of publish-kedro-viz action

action.yml

@@ -15,6 +15,10 @@ inputs:
     description: "Set your Kedro-project path to build the Kedro-Viz artifacts."
     required: false
     default: "."
+  include_hooks:
+    description: "Set whether to include hooks while creating your Kedro-project build artifacts."
+    required: false
+    default: false
   telemetry_consent:
     description: "Set your consent if you would like to participate in Kedro-Telemetry. Defaults to false"
     required: false
@@ -57,16 +61,24 @@ runs:
         cd ${{ inputs.project_path }}
         echo 'consent: ${{ inputs.telemetry_consent }}' > .telemetry
       shell: bash
+    - name: Create build flags
+      run: |
+        flag=""
+        if ${{ inputs.include_hooks }}; then
+          flag="$flag --include-hooks"
+        fi
+        echo "build_flags=$flag" >> $GITHUB_ENV
+      shell: bash
     - name: Create build directory
       run: |
         cd ${{ inputs.project_path }}
-        if !(kedro viz build |& tee /dev/stderr | grep -i -q "Success!"); then
+        if !(kedro viz build ${{ env.build_flags }} |& tee /dev/stderr | grep -i -q "Success!"); then
           exit 1
         fi
       shell: bash
     - name: Deploy to GitHub Pages with publish branch as source
       if: ${{ inputs.publishing_source == 'branch' }}
-      uses: peaceiris/actions-gh-pages@v3
+      uses: peaceiris/actions-gh-pages@v4
       with:
         github_token: ${{ inputs.github_token }}
         publish_branch: ${{ inputs.publish_branch }}