diff --git a/README.md b/README.md index a17d77d..00320c6 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,29 @@ Usage ----- -Call this composite action from any repository to run the `autodeploy/setup.sh` script included in this repo. +Call this composite action from your repository to run the `autodeploy/setup.sh` script included in this repo. -Example workflow snippet (in the caller repo): +Example workflow snippet (adjust the DEPLOY_PATH): ```yaml -name: call-autodeploy +name: Autodeploy Python +env: + DEPLOY_PATH: "/your_facility/your_folder/config/python" on: + push: + branches: + - main workflow_dispatch: jobs: - run-autodeploy: - runs-on: ubuntu-latest + autodeploy: + runs-on: alpine-autodeploy steps: - - name: Run autodeploy action from repo - uses: your-username/snek/.github/actions/autodeploy@main + - name: Pixi Deploy + uses: actions/pixi-deploy@main with: - branch: main - install_prereqs: 'true' + destination: "${{ env.DEPLOY_PATH }}" ``` Notes: