change directory structure

.github/workflows/test.yml

@@ -36,6 +36,7 @@ jobs:
       - name: Install Project Dependencies
         run: |
           python -m pip install --upgrade pip
+          cd demo-project
           pip install -r requirements.txt
       - name: Deploy Kedro-Viz to GH Pages
         uses: ravi-kumar-pilla/shareableviz-action@main

README.md

@@ -124,6 +124,9 @@ A GitHub action which deploys your Kedro-Viz static site on GitHub pages. This a
                     - name: Install Project Dependencies
                       run: |
                         python -m pip install --upgrade pip
+                        # This is not required if your Kedro Project 
+                        # is at the root of your GitHub Repository
+                        cd demo-project 
                         pip install -r requirements.txt
                       # Using the action
                     - name: Deploy Kedro-Viz to GH Pages 
@@ -143,7 +146,7 @@ After you've completed the configuration, trigger the workflow as per the workfl
 
 The list of third party actions used in this project, with due credits to their authors and license terms. More details can be found inside the folder of each action.
 
-### Deploy to GitHub Pages when publishing source is branch
+### Deploy to GitHub Pages when publishing source is a branch
 
 We use the GitHub action [peaceiris/actions-gh-pages](https://github.com/peaceiris/actions-gh-pages) to deploy the static site to a publish branch which is released under MIT license.
 

action.yml

@@ -11,14 +11,6 @@ inputs:
     description: "Set a GitHub token to authenticate deployment. This is autogenerated by the action."
     required: false
     default: ${{ github.token }}
-  publish_branch:
-    description: "Set a GitHub pages publish branch. Defaults to gh-pages"
-    required: false
-    default: "gh-pages"
-  commit_message:
-    description: "Set a commit message for the deployment. Defaults to your original commit message."
-    required: false
-    default: ${{ github.event.head_commit.message }}
   telemetry_consent:
     description: "Set your consent if you would like to participate in Kedro-Telemetry. Defaults to true"
     required: false
@@ -31,6 +23,14 @@ inputs:
     description: "Set a publishing source for GitHub pages. Defaults to branch"
     required: false
     default: "branch"
+  publish_branch:
+    description: "Set a GitHub pages publish branch. Defaults to gh-pages"
+    required: false
+    default: "gh-pages"
+  commit_message:
+    description: "Set a commit message for the deployment. Defaults to your original commit message."
+    required: false
+    default: ${{ github.event.head_commit.message }}
   user_name:
     description: "Set git config user.name. Defaults to github-actions[bot]"
     required: false

demo-project/conf/local/credentials.yml

@@ -0,0 +1,16 @@
+# Here you can define credentials for different data sets and environment.
+#
+#
+# Example:
+#
+# dev_s3:
+#     aws_access_key_id: token
+#     aws_secret_access_key: key
+#
+# prod_s3:
+#     aws_access_key_id: token
+#     aws_secret_access_key: key
+#
+# dev_sql:
+#     username: admin
+#     password: admin