Skip to content

Commit 9a7bd08

Browse files
authored
Merge branch 'main' into rw/publication-updates
2 parents a72bc58 + b3aebdd commit 9a7bd08

File tree

6 files changed

+64
-23
lines changed

6 files changed

+64
-23
lines changed

.github/workflows/ci-pr.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ jobs:
7979
id: run-code-analyzer
8080
uses: forcedotcom/run-code-analyzer@v2
8181
with:
82-
run-arguments: --workspace "force-app/**" --view detail --output-file "sca-results.csv" --config-file "code-analyzer.yml"
82+
run-arguments: --workspace "force-app/main" --view detail --output-file "sca-results.csv" --config-file "code-analyzer.yml"
8383
results-artifact-name: code-analyzer-results
8484
github-token: ${{ github.token }}
8585

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ jobs:
6262
id: run-code-analyzer
6363
uses: forcedotcom/run-code-analyzer@v2
6464
with:
65-
run-arguments: --workspace "force-app/**" --view detail --output-file "sca-results.csv" --config-file "code-analyzer.yml"
65+
run-arguments: --workspace "force-app/main" --view detail --output-file "sca-results.csv" --config-file "code-analyzer.yml"
6666
results-artifact-name: code-analyzer-results
6767
github-token: ${{ github.token }}
6868

README.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,19 @@ A collection of easy-to-digest [Agent Script](https://developer.salesforce.com/d
99
1010
## Table of contents
1111

12-
- [Salesforce CLI prerequisite](#salesforce-cli-prerequisite)
12+
- [Prerequisites](#prerequisites)
1313

1414
- Install the app with either one of these options:
1515
- **Option 1:** [Developer Edition Org installation](#installing-the-app-using-a-developer-edition-org) - Use this option if you want the app deployed to a more permanent environment than a Scratch org.
1616
- **Option 2:** [Scratch Org installation](#installing-the-app-using-a-scratch-org) - Use this option if you are a developer who wants to experience the app and the code in a temporary environment.
1717

1818
- [Optional installation instructions](#optional-installation-instructions)
1919

20-
## Salesforce CLI prerequisite
20+
## Prerequisites
21+
22+
Regardless of the installation type you chose, make sure to review the following prerequisites.
23+
24+
### Salesforce CLI Version
2125

2226
> [!IMPORTANT]
2327
> This project requires Salesforce CLI with version `2.113.6` or greater.
@@ -26,6 +30,20 @@ A collection of easy-to-digest [Agent Script](https://developer.salesforce.com/d
2630

2731
If you need to [update the Salesforce CLI](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_update_cli.htm), either run `sf update` or `npm install --global @salesforce/cli` depending on how you installed the CLI.
2832

33+
### Feature Activation
34+
35+
1. **Einstein:** Enable Einstein in your org. From **Setup**, search for **Einstein Setup** in Quick Find. Click on that entry and turn on the **Einstein** toggle.
36+
37+
1. **Agentforce:** Enable Agentforce in your org. From **Setup**, search for **Agentforce** in Quick Find. Click on **Agentforce Agents**, and turn on the **Agentforce** toggle.
38+
39+
### User Permissions
40+
41+
**Prompt Template Manager:** Assign yourself the `Prompt Template Manager` permission set. You can either do this from **Setup** or with the Salesforce CLI by running this command:
42+
43+
```bash
44+
sf org assign permset -n EinsteinGPTPromptTemplateManager
45+
```
46+
2947
## Installing the app using a Developer Edition Org
3048

3149
Follow this set of instructions if you want to deploy the app to a more permanent environment than a Scratch org.
@@ -34,10 +52,6 @@ This includes non source-tracked orgs such as a free [Developer Edition Org](htt
3452
> [!IMPORTANT]
3553
> Make sure to start from a brand-new environment to avoid conflicts with previous work you may have done.
3654
37-
1. Enable Einstein in your org. Do this via **Setup**, then search for **Einstein Setup** in Quick Find. Click on that entry and turn on the **Einstein** toggle.
38-
39-
2. Enable Agentforce in your org. In Quick Find search for **Agentforce**, click on **Agentforce Agents**, and turn on the **Agentforce** toggle.
40-
4155
3. Clone this repository:
4256

4357
```bash
@@ -79,6 +93,8 @@ This includes non source-tracked orgs such as a free [Developer Edition Org](htt
7993
> [!TIP]
8094
> **Agentforce Studio** can be reached from the App Launcher. From there, click **View All** then select the **Agentforce Studio** app.
8195

96+
**Post installation:** when working with the recipes, assign the **Agent Script Recipes Data** permission set to your agent user to avoid access issues.
97+
8298
## Installing the app using a Scratch Org
8399

84100
1. Follow these steps if you haven't configured a Dev Hub org:
@@ -131,6 +147,8 @@ This includes non source-tracked orgs such as a free [Developer Edition Org](htt
131147
> [!TIP]
132148
> **Agentforce Studio** can be reached from the App Launcher. From there, click **View All** then select the **Agentforce Studio** app.
133149
150+
**Post installation:** when working with the recipes, assign the **Agent Script Recipes Data** permission set to your agent user to avoid access issues.
151+
134152
## Optional Installation Instructions
135153
136154
This repository contains several files that are relevant if you want to integrate modern web development tools into your Salesforce development processes or into your continuous integration/continuous deployment processes.

code-analyzer.yml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1-
engines:
1+
rules:
22
flow:
3-
disable_engine: true
3+
# Disabled HardCodedId rule for flow as a temporary workaround for
4+
# https://github.com/forcedotcom/code-analyzer/issues/1947
5+
HardCodedId:
6+
severity: Critical
7+
tags: []
8+
9+
engines:
410
eslint:
511
auto_discover_eslint_config: true
612
disable_javascript_base_config: true

package-lock.json

Lines changed: 27 additions & 11 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
"url": "git+https://github.com/trailheadapps/agent-script-recipes"
1111
},
1212
"scripts": {
13+
"code-analyzer": "sf code-analyzer run --workspace force-app/main --view detail --output-file \"sca-results.csv\" --config-file \"code-analyzer.yml\"",
1314
"lint": "eslint .",
1415
"test": "npm run test:unit",
1516
"test:unit": "sfdx-lwc-jest",
@@ -41,10 +42,10 @@
4142
"@salesforce/sfdx-lwc-jest": "^7.1.2",
4243
"eslint": "^9.39.1",
4344
"eslint-plugin-import": "^2.32.0",
44-
"eslint-plugin-jest": "^29.0.1",
45+
"eslint-plugin-jest": "^29.2.1",
4546
"husky": "^9.1.7",
4647
"lint-staged": "^16.2.6",
47-
"prettier": "^3.6.2",
48+
"prettier": "^3.7.4",
4849
"prettier-plugin-apex": "^2.2.6"
4950
},
5051
"volta": {

0 commit comments

Comments
 (0)