pndurette · pndurette · Jan 14, 2024 · Jan 14, 2024 · Jan 14, 2024 · Jan 14, 2024
diff --git a/.github/workflows/test-reusable.yml b/.github/workflows/test-reusable.yml
@@ -42,6 +42,10 @@ jobs:
         with:
           urls_config: ${{ inputs.urls_config }}
           default_redirect: ${{ inputs.default_redirect }}
+      - name: Show tree (_redirects)
+        run: tree -a _redirects
+      - name: Show tree (_site)
+        run: tree -a _site
       - name: Post-Run
         run: |
           ${{ inputs.post-run }}
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -27,6 +27,20 @@ jobs:
       default_redirect: "Nothing to see!"
       post-run: bats ./tests/test_gen.bats
 
+  test-generation-paths:
+    name: Generate Redirects (sub-paths)
+    uses: ./.github/workflows/test-reusable.yml
+    with:
+      pre-run: |
+        # Create a test urls config file
+        cat <<- EOF > urls_tests.yml
+        ---
+        a/b/c/test-d: http://www.abcd.com
+        EOF
+      urls_config: urls_tests.yml
+      default_redirect: "Nothing to see!"
+      post-run: bats ./tests/test_gen_paths.bats
+
   test-default-redirect-url:
     name: Default (Redirect URL)
     uses: ./.github/workflows/test-reusable.yml

diff --git a/README.md b/README.md
@@ -91,14 +91,14 @@ See [How it works](#how-it-works).
    ---
    abc: "https://google.com"
    def: "https://yahoo.com"
-   xyz: "https://some-other-site.com"
+   uvw/xyz: "https://some-other-site.com"  # The <key> can be a path
    ```
 
    Will generate the following links:
 
    * `http://<your site>/abc` will redirect to `https://google.com`
    * `http://<your site>/def` will redirect to `https://yahoo.com`
-   * `http://<your site>/xyz` will redirect to `https://some-other-site.com`
+   * `http://<your site>/uvw/xyz` will redirect to `https://some-other-site.com`
 
    </p>
    </details>
@@ -131,11 +131,11 @@ Each URL to redirect is created by the action as an individual document defined
 collections:
   redirects:
     output: true
-    permalink: /:name
+    permalink: /:path
 
 ```
 
-*The above reads: "In `_redirects` (Jekyll's convention), generate one file per document (`output: true`) for which the final URL path will be `/:name` (i.e. name of the file, minus the extension)"*
+*The above reads: "In `_redirects` (Jekyll's convention), generate one file per document (`output: true`) for which the final URL path will be `/:path` (i.e. path to the file, including the file, minus the extension)"*
 
 For example, for an entry `link1: "https://google.com"` in `urls.yml`, the action would create `_redirect/link1.yml` as:
 
@@ -185,7 +185,7 @@ The generated file hierarchy is minimal. For instance, for a `urls.yml` that mig
 ---
 abc: "https://google.com"
 def: "https://yahoo.com"
-xyz: "https://some-other-site.com"
+uvw/xyz: "https://some-other-site.com"
 ```
 
 The action will generate (if the action input `default_redirect` is set to a URL):
@@ -197,7 +197,8 @@ The action will generate (if the action input `default_redirect` is set to a URL
 ├── _redirects
 │   ├── abc.md
 │   ├── def.md
-│   └── xyz.md
+│   └── uvw
+|       └── xyz.md
 └── index.md
 ```
 
@@ -210,7 +211,8 @@ And the GitHub Pages-hosted directory will look like:
 ├── def.html
 ├── index.html
 ├── redirects.json
-└── xyx.html
+└── uvw
+    └── xyx.html
 ```
 
 ## License

diff --git a/tests/test_gen_paths.bats b/tests/test_gen_paths.bats
@@ -0,0 +1,30 @@
+setup() {
+    # Create expected Jekyll files:
+    # temp-d.md
+    cat <<- EOF > temp-d.md
+---
+redirect_to: http://www.abcd.com
+---
+EOF
+}
+
+## Check if the Action
+##  * Generated the proper Markdown file
+##  * Generated the proper Markdown content
+
+@test "a/b/c/temp-d.md should be generated" {
+    test -f _redirects/a/b/c/test-d.md
+    diff    _redirects/a/b/c/test-d.md temp-d.md
+}
+
+## Check if Jekyll:
+##  * Generated the proper html file
+##  * Generated the proper html content
+##      * Contains "<!DOCTYPE html>"
+##      * Contains the URL redirect
+
+@test "test-d.html should be generated" {
+    test -f _site/a/b/c/test-d.html
+    cat _site/a/b/c/test-d.html | grep "<\!DOCTYPE html>"
+    cat _site/a/b/c/test-d.html | grep "http://www.abcd.com"
+}