https://github.com/svierk/sfdx-package-installation

📦 Github composite action for installing packages on a specific Salesforce org
https://github.com/svierk/sfdx-package-installation

composite-action github-actions salesforce sfdx sfdx-cli

Last synced: about 1 month ago
JSON representation

📦 Github composite action for installing packages on a specific Salesforce org

• Host: GitHub
• URL: https://github.com/svierk/sfdx-package-installation
• Owner: svierk
• License: mit
• Created: 2024-03-21T19:10:09.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-05-17T10:24:09.000Z (6 months ago)
• Last Synced: 2024-05-18T09:43:52.559Z (6 months ago)
• Topics: composite-action, github-actions, salesforce, sfdx, sfdx-cli
• Homepage: https://github.com/marketplace/actions/sfdx-package-installation
• Size: 4.88 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 📦 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:

```

jobs:

  validation:

    name: Validation

    runs-on: ubuntu-latest

    steps:

      - name: Checkout

        uses: actions/checkout@v4

      - name: Select Node Version

        uses: svierk/get-node-version@main

      - name: Install Dependencies

        run: npm ci

      

      - name: Install SF CLI

        uses: svierk/sfdx-cli-setup@main

        

      - name: Salesforce Org Login

        uses: svierk/sfdx-login@main

        with:

          sfdx-url: ${{ secrets.SFDX_AUTH_URL }}

    

      - name: Package Installation

        uses: svierk/sfdx-package-installation@main

        with:

          packages: "['04t6S000001UjutQAC','04t3y000000X0OaAAK']"

          wait: 30

          publish-wait: 20

```

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'.

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

- [Get Node Version](https://github.com/svierk/get-node-version) | Pulls Node.js version to be used from the _package.json_ of the project

- [SFDX CLI Setup](https://github.com/svierk/sfdx-cli-setup) | Installs the Salesforce CLI and related plugins

- [SFDX Login](https://github.com/svierk/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.

## Releases

Latest release notes can be found on the [release page](https://github.com/svierk/sfdx-package-installation/releases).

## License

The scripts and documentation in this project are released under the [MIT License](https://github.com/svierk/sfdx-package-installation/blob/main/LICENSE).