Repository navigation
Deploy failing: This command can only be run in a Serverless service directory. #53
Description
Activity
I am experiencing the same issue. I tried using the working directory setting and it still did not work.
This is my main.yml:
name: Deploy master branch on: push: branches: - master jobs: deploy: name: deploy runs-on: ubuntu-latest defaults: run: working-directory: ./app strategy: matrix: node-version: [12.x] steps: - uses: actions/checkout@v2 - name: Use Node.js ${{ matrix.node-version }} uses: actions/setup-node@v1 with: node-version: ${{ matrix.node-version }} - run: npm ci - name: serverless deploy uses: serverless/github-action@master with: args: deploy env: # SERVERLESS_ACCESS_KEY: ${{ secrets.SERVERLESS_ACCESS_KEY }} # or if using AWS credentials directly AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }} AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}This gave me the same error.
couldn't find anyway to make it run either. I think it's because of this:
-v "/home/runner/work/berry/berry":"/github/workspace"By default the serverless docker maps the parent folder. Would be nice if there's an option to change that.
Ended up writing my own commands.
name: GitHub Actions Deploy ID Dev on: push: branches: - main jobs: deploy: name: deploy runs-on: ubuntu-latest strategy: matrix: node-version: [14.x] steps: - uses: actions/checkout@v2 - name: Use Node.js ${{ matrix.node-version }} uses: actions/setup-node@v1 with: node-version: ${{ matrix.node-version }} - run: yarn install - run: yarn workspace @berry/shared build - run: node ./node_modules/serverless/bin/serverless.js config credentials --provider aws --key ${{ secrets.AWS_ACCESS_KEY_ID }} --secret ${{ secrets.AWS_SECRET_ACCESS_KEY }} --profile papaya --overwrite - run: node ../../node_modules/serverless/bin/serverless.js deploy --aws-s3-accelerate --stage dev --verbose working-directory: ./services/id env: SERVERLESS_ACCESS_KEY: ${{ secrets.SERVERLESS_ACCESS_KEY }} AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }} AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }} SLS_DEBUG: 1
Reacted by Alex Freas, mikkel-arturo, Harsh Baid, Stephen Grable, diegohsitec and i.kurskiReacted by Stephen Grable, diegohsitec and Patrick FelberYou need to set the config variable on the serverless deploy command to the path of the serverless.yml file:
name: serverless deploy uses: serverless/github-action@master with: args: deploy -s stage -c path/to/file/serverless.ymlReacted by Philihp Busby, Mert Eroğlu, Roni, Sehrish Waheed and Zoe EdwardsYou need to set the config variable on the serverless deploy command to the path of the serverless.yml file:
name: serverless deploy uses: serverless/github-action@master with: args: deploy -s stage -c path/to/file/serverless.ymlThis does not work if you are loading other files in your
serverless.yml.Serverless Warning -------------------------------------- A valid file to satisfy the declaration 'file(dev-config.yaml):environment' could not be found.You need to set the config variable on the serverless deploy command to the path of the serverless.yml file:
name: serverless deploy uses: serverless/github-action@master with: args: deploy -s stage -c path/to/file/serverless.ymlThis still doesn't work due to the fact that my repo is a monorepo and so all my serverless functions are inside a serverless folder inside my repo.
Repo Structure looks something like this
/package.json /<ReactJS Project Files> /serverless /serverless/serverless.yml /serverless/index.js <- contains function info /serverless/package.jsonHere was the deploy command I was using but couldn't get it to work:
name: Deploy to AWS Lambda on: push: branches: [ master ] jobs: build: runs-on: ubuntu-latest steps: - name: Checkout Code uses: actions/checkout@v2 - name: Build w/ Node.js 14.x uses: actions/setup-node@v2 with: node-version: 14.x - run: npm ci working-directory: ./serverless - name: Serverless Deploy uses: serverless/github-action@master with: args: -c "serverless plugin install --name serverless-domain-manager && serverless deploy -c serverless/serverless.yml -v" entrypoint: /bin/sh env: AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }} AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}Honestly have sort of given up on this. It's clear Serverless has no intention of providing support for github actions.
Reacted by Akin AdekoyaYou need to set the config variable on the serverless deploy command to the path of the serverless.yml file:
name: serverless deploy uses: serverless/github-action@master with: args: deploy -s stage -c path/to/file/serverless.ymlThis still doesn't work due to the fact that my repo is a monorepo and so all my serverless functions are inside a serverless folder inside my repo.
Repo Structure looks something like this
/package.json /<ReactJS Project Files> /serverless /serverless/serverless.yml /serverless/index.js <- contains function info /serverless/package.jsonHere was the deploy command I was using but couldn't get it to work:
name: Deploy to AWS Lambda on: push: branches: [ master ] jobs: build: runs-on: ubuntu-latest steps: - name: Checkout Code uses: actions/checkout@v2 - name: Build w/ Node.js 14.x uses: actions/setup-node@v2 with: node-version: 14.x - run: npm ci working-directory: ./serverless - name: Serverless Deploy uses: serverless/github-action@master with: args: -c "serverless plugin install --name serverless-domain-manager && serverless deploy -c serverless/serverless.yml -v" entrypoint: /bin/sh env: AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }} AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}Honestly have sort of given up on this. It's clear Serverless has no intention of providing support for github actions.
Seems like the solution i provided previously only works for single lambdas.
I apologise that this does not represent most cases that people encounter in real life scenarios.I have had luck calling serverless directly via npx, see here as an example. CLI commands/flags should work as indentended - but I havn't tried with a monorepo setup or using other yml files in the serverless.yml file (hopefully is not the same result as before).
I am keen to see the result of such running serverless with the above method - hopefully we can help progress this GHA.
Reacted by Harsh BaidAnyone encountering this thread who's following best practices and splitting their serverless app into separate directories, follow @deathemperor solution above (or my slightly simplified one below) to roll your own deployment step for each of your services.
Any semi-mature application will eventually need to split their code. I recommend you do not consolidate your separate services into the root folder just so this github action will work -- you will end up having to backtrack once your app grows.
It would be great if we could add support for this eventually, but in the meantime, I'm dropping this github action and using this manual deployment setup:
name: GitHub Actions Deploy Prod on: push: branches: - master jobs: deploy: name: deploy runs-on: ubuntu-latest strategy: matrix: node-version: [14.x] steps: - uses: actions/checkout@v2 - name: Use Node.js ${{ matrix.node-version }} uses: actions/setup-node@v1 with: node-version: ${{ matrix.node-version }} - run: npm install - run: npm run build - run: node ./node_modules/serverless/bin/serverless.js config credentials --provider aws --key ${{ secrets.AWS_ACCESS_KEY_ID }} --secret ${{ secrets.AWS_SECRET_ACCESS_KEY }} - run: node ../../node_modules/serverless/bin/serverless.js deploy --stage prod --verbose working-directory: ./serverless/backend-api env: AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }} AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }} SLS_DEBUG: 1
thanks again for the suggestion @deathemperor
Reacted by deathemperor, diegohsitec, Philihp Busby and Carl Walsh- added 4 commits that reference this issue
on Sep 20, 2021 Update... if you add org and app properties to serverless.yaml then the serverless client requires a
SERVERLESS_ACCESS_KEYconfigured in serverless.com UX console.My subdirectory is called
server, note the use ofworking-directoryat top level rather than for each step.name: Deploy main branch serverless on: push: branches: - main jobs: deploy: name: deployserver runs-on: ubuntu-latest defaults: run: working-directory: ./server strategy: matrix: node-version: [14.x] steps: - uses: actions/checkout@v2 - name: Use Node.js ${{ matrix.node-version }} uses: actions/setup-node@v1 with: node-version: ${{ matrix.node-version }} - run: yarn - run: node ./node_modules/serverless/bin/serverless.js deploy --stage prod --verbose env: SERVERLESS_ACCESS_KEY: ${{ secrets.SERVERLESS_ACCESS_KEY }} SLS_DEBUG: 1@pgrzesik Thanks for the note. Sure... here are logs of attempting to run without
SERVERLESS_ACCESS_KEY. Literally the only change required to get my deploy to work is to add a validSERVERLESS_ACCESS_KEYto theenvsection of the yaml file.Run node ./node_modules/serverless/bin/serverless.js config credentials --provider aws --key *** --secret *** node ./node_modules/serverless/bin/serverless.js config credentials --provider aws --key *** --secret *** shell: /usr/bin/bash -e {0} Serverless: Setting up AWS... 2s Run node ./node_modules/serverless/bin/serverless.js deploy --stage prod --verbose node ./node_modules/serverless/bin/serverless.js deploy --stage prod --verbose shell: /usr/bin/bash -e {0} env: AWS_ACCESS_KEY_ID: *** AWS_SECRET_ACCESS_KEY: *** Serverless Error ---------------------------------------- You are not currently logged in. Follow instructions in http://slss.io/run-in-cicd to setup env vars for authentication.Hey @hutch120 - thanks for responding. Based on the error message it seems like you're using Serverless Dashboard integration in your service - do you have
organdappproperties defined in yourserverless.yml? If that's the case, then yes, SERVERLESS_ACCESS_KEY is required, because otherwise it would be impossible to use the Dashboard integration. If you are not using Dashboard, you can remove theorgandappsetttings and key will be no longer needed.@pgrzesik Thanks for the info. I stand corrected. I've updated my initial comment. FYI I guess the reason I got to this conclusion was by following along with this general guide and this CI guide
Hey @hutch120 - happy I could help clear up some misunderstanding 👍 As for these guides, I'm looking at them and I see that the second one about CI setup might definitely be misleading, as it suggests that if you're using CI, then you need to use Dashboard which is definitely not the case. I'll bring it up internally so we can clear that confusion in documentation as well 👍
https://ryan-schachte.com/posts/serverless-deployments-with-github-actions-on-aws
I wrote a post setting this deployment up on Github actions. Might help some people out there.
Reacted by Oluwatosin Temitope Akande and Oisin O'ReillyI handled this issue by overriding the
ENTRYPOINTand changing to the directory that contains myserverless.ymlthis wayjobs: deploy: name: deployserver ... steps: - name: serverless deploy uses: serverless/github-action@v3 with: args: -c "cd ./<your-dir> && serverless deploy" entrypoint: /bin/shChange
<your-dir>to your target directory.Reacted by blackn1ght, James Kirk, Satoru Kitaguchi, emahiro, Brighton Chabula, Kevin, Mert Eroğlu, Sulaiman Khan Ghori, Edison Smith Calderón Sánchez, Leandro Mantovani and 8 more- added a commit that references this issue
on Apr 25, 2022 - added a commit that references this issue
on May 17, 2022 Thanks, I added this info in the readme.
I handled this issue by overriding the
ENTRYPOINTand changing to the directory that contains myserverless.ymlthis wayjobs: deploy: name: deployserver ... steps: - name: serverless deploy uses: serverless/github-action@v3 with: args: -c "cd ./<your-dir> && serverless deploy" entrypoint: /bin/shChange
<your-dir>to your target directory.So I am doing this now, but get
/bin/sh: 1: serverless: not founderror. Am I doing something wrong? What should the content of thepackage.jsonlook like? As in does it need any specific dependencies fornpm ci?
I have a mono repo project and a separate directory that contains the serverless yaml file. Is there a way to set the directory to execute from in the github action.
I tried doing something like this:
but without any luck.