{"id":22181570,"url":"https://github.com/gfarb/sfdx-deploy","last_synced_at":"2025-06-15T20:07:31.816Z","repository":{"id":56810184,"uuid":"525537893","full_name":"gfarb/sfdx-deploy","owner":"gfarb","description":" Salesforce Deploy is a lightweight GitHub Action that allows you to quickly and safely automate your Salesforce build, test and deploy pipeline using GitHub Workflows.","archived":false,"fork":false,"pushed_at":"2023-05-12T18:51:18.000Z","size":34193,"stargazers_count":11,"open_issues_count":3,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-31T10:38:39.579Z","etag":null,"topics":["salesforce","salesforce-developers","sfdx"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gfarb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-08-16T20:47:29.000Z","updated_at":"2024-07-27T18:12:01.000Z","dependencies_parsed_at":"2023-01-04T12:30:56.086Z","dependency_job_id":null,"html_url":"https://github.com/gfarb/sfdx-deploy","commit_stats":{"total_commits":10,"total_committers":3,"mean_commits":"3.3333333333333335","dds":"0.19999999999999996","last_synced_commit":"bbf7e14a364b06fb80394b4da2c33bade9633d16"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gfarb%2Fsfdx-deploy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gfarb%2Fsfdx-deploy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gfarb%2Fsfdx-deploy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gfarb%2Fsfdx-deploy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gfarb","download_url":"https://codeload.github.com/gfarb/sfdx-deploy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227481827,"owners_count":17779963,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["salesforce","salesforce-developers","sfdx"],"created_at":"2024-12-02T09:40:57.739Z","updated_at":"2024-12-02T09:40:58.583Z","avatar_url":"https://github.com/gfarb.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Salesforce Deploy Action\n\nSalesforce Deploy is a lightweight GitHub Action that allows you to quickly and safely automate your Salesforce build, test and deploy pipeline using GitHub Workflows.\n\nUses the Salesforce CLI to create a manifest from one or more local directories that contain source files by running the `force:source:convert` command and runs the `force:source:deploy` command to test in and deploy to a target environment.\n\nSupports both pre and post destructive changes.\n\n![](https://user-images.githubusercontent.com/22826414/185196841-8570dd5f-6560-465b-87ec-4df36f0d9f8d.gif)\n\n## Usage\n\n```yml\n- uses: actions/sfdx-deploy\n  env:\n    # Username or alias for the target org. Must be pre-authorized.\n    # Required\n    TARGET_USERNAME: \"\"\n\n    # Comma-separated list of paths to the local source files to include in the manifest.\n    # Default value: force-app\n    SOURCE_PATH: \"\"\n\n    # Path to folder containing manifests (destructiveChangesPre.xml, destructiveChangesPost.xml)\n    # of components to delete before and/or after the deploy.\n    # Default value: destructive-changes\n    DESTRUCTIVE_CHANGES: \"\"\n\n    # Specifies which level of deployment tests to run.\n    # Default value: RunLocalTests\n    TEST_LEVEL: \"\"\n\n    # Number of minutes to wait for the command to complete and display results to the terminal window.\n    # Default value: 33\n    WAIT: \"\"\n```\n\n## Outputs\n\n- `DEPLOYED`: Boolean value that identifies if the deployment was successful.\n- `DESTRUCTIVE_CHANGES`: Boolean value that identifies if destructive changes were present.\n\n## Example Workflow\n\n```yml\non:\n  push:\n    branches:\n      - \"master\"\nname: Deploy to Salesforce Production\njobs:\n  deploy:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v3\n\n      - name: Setup Node\n        uses: actions/setup-node@v3\n        with:\n          node-version: \"14\"\n\n      - name: Cache node modules\n        uses: actions/cache@v3\n        id: npm_cache_id\n        with:\n          path: node_modules\n          key: ${{ runner.os }}-npm-cache-${{ hashFiles('**/package-lock.json') }}\n          restore-keys: |\n            ${{ runner.os }}-npm-cache-\n            ${{ runner.os }}-\n\n      - name: Install Dependencies\n        if: steps.npm_cache_id.outputs.cache-hit != 'true'\n        run: npm ci\n\n      - name: SFDX Auth\n        env:\n          SFDX_JWT_KEY: ${{ secrets.SFDX_JWT_KEY }}\n          SFDX_CLIENT_ID: ${{ secrets.SFDX_CLIENT_ID }}\n        run: |\n          echo \"${SFDX_JWT_KEY}\" \u003e server.key\n          npx sfdx force:auth:jwt:grant --clientid \"${SFDX_CLIENT_ID}\" --jwtkeyfile server.key --username gfarb@github.dreamforce --setdefaultdevhubusername\n          npx sfdx force:org:display --json -u gfarb@github.dreamforce \u003e sfdx-auth.json\n          rm server.key\n\n      - name: Build, Test \u0026 Deploy\n        uses: gfarb/sfdx-deploy@v1\n        env:\n          TARGET_USERNAME: gfarb@github.dreamforce\n          SOURCE_PATH: force-app\n          DESTRUCTIVE_CHANGES: destructive-changes\n          TEST_LEVEL: RunLocalTests\n          WAIT: 200\n```\n\n## Resources\n\n- [Deploying and Retrieving Salesforce Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based.htm)\n- [Deleting Components from an Organization](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_deleting_files.htm)\n- [`force:source:convert`](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_force_source.htm#cli_reference_force_source_convert)\n- [`force:source:deploy `](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_force_source.htm#cli_reference_force_source_deploy)\n\n## License\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgfarb%2Fsfdx-deploy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgfarb%2Fsfdx-deploy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgfarb%2Fsfdx-deploy/lists"}