https://github.com/m50/setup-sfdx-action
A simple github action to setup sfdx with any plugins for use in actions.
https://github.com/m50/setup-sfdx-action
Last synced: over 1 year ago
JSON representation
A simple github action to setup sfdx with any plugins for use in actions.
- Host: GitHub
- URL: https://github.com/m50/setup-sfdx-action
- Owner: m50
- License: mit
- Created: 2021-01-21T01:00:29.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-09-12T01:29:55.000Z (almost 5 years ago)
- Last Synced: 2025-02-24T07:43:55.588Z (over 1 year ago)
- Language: JavaScript
- Size: 128 KB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Setup SFDX
A simple github action to setup sfdx with any plugins for use in actions.
## Inputs
### `plugins`
This optional input takes a CSV list of plugins to install into SFDX.
### `client-id`
The JWT client ID for JWT authentication. Can be used in place of sfdxurl authentication.
Required with `jwt-key`.
### `jwt-key`
The JWT private key for JWT authentication. Can be used in place of sfdxurl authentication.
Required with `client-id`.
### `sfdxurl`
The sfdx URL for authentication. Can be used in place of JWT authentication.
Must by in one of the following formats:
- `force://@`
- `force://::@`
You can display the constructed sfdxurl using the verbose mode of org display:
```
sfdx force:org:display -u YourExistingOrgAliasName --verbose | grep "Sfdx Auth Url" | awk '{print $4}'
```
### `org-alias`
The alias to use for the organization logged in as.
**Default**: test
### `sandbox`
Whether authentication is happening in a sandbox. Only used with JWT authentication.
**Default**: 'true'
## Example usage
### No authentication
```yaml
uses: m50/setup-sfdx-action@v0.1
with:
plugins: skuid-sfdx
```
### SFDXURL authentication
```yaml
uses: m50/setup-sfdx-action@v0.1
with:
plugins: skuid-sfdx
sfdxurl: ${{ secrets.SFDXURL }}
```
### JWT Authentication
```yaml
uses: m50/setup-sfdx-action@v0.1
with:
plugins: skuid-sfdx
cliend-id: ${{ secrets.SF_CLIENT_ID }}
jwt-key: ${{ secrets.SF_JWT_KEY }}
```