Skip to content

Commit

Permalink
refactor(action): clean up action docs and descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
svierk committed Mar 22, 2024
1 parent 6b1f906 commit cff0e88
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The SF CLI in this example workflow is installed via the action [sfdx-cli-setup]
The JWT login flow requires a custom connected app to be created as well as a digital certificate, also called a digital signature, to sign the JWT request. You can create a self-signed certificate using OpenSSL. How to achieve this is already well documented:

- [Authorize an Org Using the JWT Flow](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_auth_jwt_flow.htm) | Salesforce DX Developer Guide
- [How To Use GitHub Actions, OAuth and SFDX-CLI for Continuous Integration](https://salesforcedevops.net/index.php/2022/04/05/how-to-use-github-actions-oauth-and-sfdx-cli-for-continuous-integration/)
- [How To Use GitHub Actions, OAuth and SFDX-CLI for Continuous Integration](https://salesforcedevops.net/index.php/2022/04/05/how-to-use-github-actions-oauth-and-sfdx-cli-for-continuous-integration/) | Blog Post

The following three parameters must be passed to the login action:

Expand Down
14 changes: 7 additions & 7 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name: 'SFDX Login'
description: 'Salesforce login action that either uses a SFDX Auth URL or the JWT based login flow.'
name: SFDX Login
description: Salesforce login action that either uses a SFDX Auth URL or the JWT based login flow.

branding:
icon: 'log-in'
color: 'blue'
icon: log-in
color: blue

inputs:
sfdx-url:
Expand All @@ -14,13 +14,13 @@ inputs:
Also, the "instanceUrl" inside the SFDX authorization URL doesn't include the protocol ("https://").
required: false
client-id:
description: 'OAuth client ID (also called consumer key) of the custom connected app for the JWT login flow.'
description: OAuth client ID (also called consumer key) of the custom connected app for the JWT login flow.
required: false
jwt-secret-key:
description: 'Contents of the server.key file containing the private key for the JWT login flow.'
description: Contents of the server.key file containing the private key for the JWT login flow.
required: false
username:
description: 'Username of the user logging in for the JWT login flow.'
description: Username of the user logging in for the JWT login flow.
required: false
set-default-dev-hub:
description: Set the authenticated org as the default Dev Hub.
Expand Down

0 comments on commit cff0e88

Please sign in to comment.