Salesforce DevOps Starter Kit

Appearance

📦 SFDX Package Installation ​

This repository implements a simple GitHub composite action for installing packages on a specific Salesforce target org.

Usage ​

After installing the SF CLI and authorizing the relevant org in your GitHub workflow, packages can be installed using this action as follows:

yaml
jobs:
  validation:
    name: Validation
    runs-on: ubuntu-latest
    permissions:
      contents: read # least privilege - the installation itself needs no write access
    steps:
      - name: Checkout
        uses: actions/checkout@v7.0.1
        with:
          persist-credentials: false # the GITHUB_TOKEN is not needed after the checkout - don't leave it in .git/config

      - name: Select Node Version
        uses: svierk/get-node-version@v1.5.1

      - name: Install Dependencies
        run: npm ci

      - name: Install SF CLI
        uses: svierk/sfdx-cli-setup@v1.1.3

      - name: Salesforce Org Login
        uses: svierk/sfdx-login@v1.4.2
        with:
          sfdx-url: ${{ secrets.SFDX_AUTH_URL }}

      - name: Package Installation
        uses: svierk/sfdx-package-installation@v1.2.1
        with:
          packages: "['04t6S000001UjutQAC','04t3y000000X0OaAAK']"
          wait: 30
          publish-wait: 20

Every action above is pinned to an exact release tag instead of a moving reference like @main, so a workflow run is reproducible and an update is always an explicit, reviewable change.

If the packages you want to install are key-protected, you can simply append the required installation key for each package with an underscore, e.g. 04t6S000001UjutQAC_INSTALLATIONKEY. Since an installation key is a credential, keep it in a GitHub Actions secret rather than in the workflow file:

yaml
- name: Package Installation
  uses: svierk/sfdx-package-installation@v1.2.1
  with:
    packages: "['04t6S000001UjutQAC_${{ secrets.SFDX_PACKAGE_KEY }}']"

The action masks every installation key in the job log and never prints it, so keys stay hidden even if they are passed as a literal value.

The following actions were also used in the example workflow to create the prerequisites for the package installation:

  • Get Node Version | Pulls Node.js version to be used from the package.json of the project
  • SFDX CLI Setup | Installs the Salesforce CLI and related plugins
  • SFDX Login | Handles Salesforce login using a Salesforce DX authorization URL

Of course, the package installation action can be used flexibly and the respective approach can vary.

Inputs ​

NameRequiredDefaultDescription
packagesyesPackages to install as a JSON array of aliases or IDs, e.g. "['04t...','04t...']". Append _<key> to a package ID for key-protected installs.
target-orgnoUsername or alias of the target org. Not required if the default org is set.
api-versionnoOverride the api version used for api requests, e.g. 59.0.
waitno0Number of minutes to wait for installation status.
publish-waitno0Maximum minutes to wait for the Subscriber Package Version ID to become available before canceling.
step-summarynotrueWrite a result section to the GitHub Actions job summary. Set to false to avoid collisions with a custom workflow summary.

Releases ​

Latest release notes can be found on the release page.

License ​

The scripts and documentation in this project are released under the MIT License.

➡️ Full source & releases: svierk/sfdx-package-installation

Released under the MIT License.

Copyright © Sebastiano Schwarz