Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
nvuillam committed Dec 21, 2024
1 parent 0c0194b commit a8fa3a2
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/salesforce-deployment-assistant-error-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -1202,7 +1202,7 @@ Please check https://developer.salesforce.com/forums/?id=9060G0000005kVLQAY
**Detection**
- RegExp: `0%`
- RegExp: ` 0%`
**Resolution**
Expand Down
8 changes: 7 additions & 1 deletion docs/salesforce-deployment-assistant-home.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,16 @@ Deployment errors are common and quite boring, right ?

Sfdx-hardis deployment assistant will help you to solve them, even if you are not using sfdx-hardis CI/CD pipelines !

The assistant contain core rules and can be integrated with AI to provide you the best guidance :)
The assistant contain core rules and can optionally be integrated with AI to provide you the best guidance :)

![](assets/images/AI-Assistant.gif)

## Flow Visual Git Diff

In addition to deployment tips, comments will be posted with Visual Git Diff for Flows.

![](assets/images/flow-visual-git-diff.gif)

## Integrations

Deployment assistant will provide tips in Pull Request comments (GitHub, Gitlab, Azure, Bitbucket).
Expand Down
21 changes: 13 additions & 8 deletions docs/salesforce-deployment-assistant-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,20 @@ description: Learn how to setup Salesforce deployment assistant

# Setup Salesforce Deployment Assistant

## Using sfdx-hardis CI/CD

If you are using [sfdx-hardis CI/CD](https://sfdx-hardis.cloudity.com/salesforce-ci-cd-home/), you are already all set !
## Configure integrations

Just make sure to have configured your [GitHub](salesforce-ci-cd-setup-integration-github.md), [Gitlab](salesforce-ci-cd-setup-integration-gitlab.md), [Azure Pipelines](salesforce-ci-cd-setup-integration-azure.md) or [BitBucket](salesforce-ci-cd-setup-integration-bitbucket.md) integration so the deployment assistant can post its help in Pull Request comments.
Make sure to have configured your [GitHub](salesforce-ci-cd-setup-integration-github.md), [Gitlab](salesforce-ci-cd-setup-integration-gitlab.md), [Azure Pipelines](salesforce-ci-cd-setup-integration-azure.md) or [BitBucket](salesforce-ci-cd-setup-integration-bitbucket.md) integration so the deployment assistant can post its help in Pull Request comments.

If you want to **supercharge Salesforce deployment assistant with AI**, process [sfdx-hardis AI setup](salesforce-ai-setup.md).

You can also receive [Slack](salesforce-ci-cd-setup-integration-slack.md), [Ms Teams](salesforce-ci-cd-setup-integration-ms-teams.md) and [Email](salesforce-ci-cd-setup-integration-email.md) notifications in case of successful deployment.

If you configure [JIRA](salesforce-ci-cd-setup-integration-jira.md) or [Generic Ticketing](salesforce-ci-cd-setup-integration-generic-ticketing.md) integrations, ticket numbers will be extracted and displayed in the Pull Request comment.

## Using sfdx-hardis CI/CD

If you are using [sfdx-hardis CI/CD](https://sfdx-hardis.cloudity.com/salesforce-ci-cd-home/), you are already all set !

## Using custom CI/CD pipeline

Replace your calls to Salesforce CLI by calls to sfdx-hardis commands wrapper.
Expand All @@ -31,15 +37,14 @@ Configure your [GitHub](salesforce-ci-cd-setup-integration-github.md), [Gitlab](

_Notes:_

- _sfdx-hardis deployment assistant currently do not support --json option. If you really need it please request it in sfdx-hardis GitHub issues !_
- _there is no sfdx-hardis wrapper command yet for `sf project deploy start`. If you really need it please request it in sfdx-hardis GitHub issues !_
- _sfdx-hardis deployment assistant now works better with **--json** option please use it :)

### Example

Replace:

`sfdx force:source:deploy -x manifest/package.xml --checkonly`
`sf project:deploy:start -x manifest/package.xml --checkonly`

by

`sf hardis:source:deploy -x manifest/package.xml --checkonly`
`sf hardis:project:deploy:start -x manifest/package.xml --checkonly`

0 comments on commit a8fa3a2

Please sign in to comment.