defaults.run.working-directory is not respected

[esemeniuc]

Describe the bug

When I set defaults.run.working-directory, I would believe that the working directory would apply to the deployment. But it looks like folder still works from /home/runner/MY_REPO/MY_REPO

Reproduction Steps

Add to top of workflow:

defaults:
  run:
    working-directory: client

Use a deployment stage like this:

      - name: Deploy 🚀
        uses: JamesIves/github-pages-deploy-action@4.1.1
        with:
          folder: out # source folder path
          repository-name: gh-pages-frontend # target repo name
          branch: master # target branch name
          target-folder: docs
          clean: true # cleans the target repo destination

Logs

Run JamesIves/github-pages-deploy-action@4.1.1

    GitHub Pages Deploy Action 🚀

    🚀 Getting Started Guide: https://github.com/marketplace/actions/deploy-to-github-pages
    ❓ Discussions / Q&A: https://github.com/JamesIves/github-pages-deploy-action/discussions
    🔧 Report a Bug: https://github.com/JamesIves/github-pages-deploy-action/issues

    📣 Maintained by James Ives: https://jamesiv.es
    💖 Support: https://github.com/sponsors/JamesIves
Checking configuration and starting deployment… 🚦
Error: The directory you're trying to deploy named /home/runner/work/monorepo/monorepo/out doesn't exist. Please double check the path and any prerequisite build scripts and try again. ❗
Deployment failed! ❌

Additional Comments

I would expect the directory to be /home/runner/work/monorepo/monorepo/client/out

[JamesIves]

Can you show me the rest of your workflow? I'm mostly curious about your checkout/build step so I can reproduce this.

[esemeniuc]

This is the whole workflow:

name: Build and Deploy Client
on: [ push ]

defaults:
  run:
    working-directory: client

jobs:
  build-and-deploy-client:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout 🛎️
        uses: actions/checkout@v2

      - name: Sanity Check + Yarn 2 ✅
        run: |
          echo "  - Node version: $(node -v)"
          echo "  - NPM version: $(npm -v)"
          yarn set version berry
          echo "  - Yarn version: $(yarn -v)"
          echo "  - Working in directory: $(pwd)"

      - name: Get yarn cache directory path ⚙️
        id: yarn-cache-dir-path
        run: echo "::set-output name=dir::$(yarn config get cacheFolder)"

      - name: Cache check (and restore if cache-hit) ⚡
        uses: actions/cache@v2
        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
        with:
          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
          restore-keys: |
            ${{ runner.os }}-yarn-

      - name: Install deps 🔧
        run: yarn install --immutable #reinstall because cache doesn't capture the entire install state

      - name: Build FE 🏗️
        run: yarn ghpublish

      - name: Deploy 🚀
        uses: JamesIves/github-pages-deploy-action@4.1.1
        with:
          folder: client/out # source folder path
          repository-name: gh-pages-frontend # target repo name
          branch: master # target branch name
          target-folder: docs
          clean: true # cleans the target repo destination

[JamesIves]

Thanks, I'll update you once this is ready.

[esemeniuc]

Awesome, thanks :)

[JamesIves]

I did some research on the working-directory option today and I believe there's an error in your workflow based on what I've researched. As you've set the base working directory to client there's no need to include it in the directory path. The following should work for you:

defaults:
  run:
    working-directory: client

      - name: Deploy 🚀
        uses: JamesIves/github-pages-deploy-action@4.1.1
        with:
          folder: out
          repository-name: gh-pages-frontend
          branch: master
          target-folder: docs
          clean: true

The only variable that is available to action creators for this purpose is process.env.GITHUB_WORKSPACE which should automatically context switch when a working-directory value is provided. I was able to use this pattern in my own workflow and it worked without issue.

Lemme know if this is helpful and if it works for you.

[JamesIves]

Checking in to see if this worked for you or not? If so I'm going to close this issue.