Skip to content

Commit

Permalink
docs: update sf command line references
Browse files Browse the repository at this point in the history
  • Loading branch information
scolladon committed Oct 5, 2024
1 parent 14fb778 commit ded5517
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 13 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,15 @@ Issue verification check:
Ex:
https://github.com/scolladon/sfdx-git-delta-reproduction-playground
sgd -d -r . -f HEAD^
sfdx sgd:source:delta -d -f HEAD^
sf sgd source delta -d -f HEAD^
-->

## Execution context

---

<!--
$ uname -v ; yarn -v ; node -v ; git --version ; sfdx --version ; sfdx plugins
$ uname -v; yarn -v ; node -v ; git --version ; sf --version ; sf plugins
-->

**Operating System:**
Expand All @@ -70,7 +70,7 @@ $ uname -v ; yarn -v ; node -v ; git --version ; sfdx --version ; sfdx plugins

**git version:**

**sfdx version:**
**sf version:**

**sgd plugin version:**

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/on-main-push.yml
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ jobs:
- name: Install plugin
run: |
yarn set version classic
sfdx plugins:link .
sfdx plugins
sf plugins link .
sf plugins
- name: Checkout e2e test subject
uses: actions/checkout@v4
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/on-merged-pull-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ jobs:
message: |
Published under `${{ env.DEV_CHANNEL }}` npm channel.
```sh
$ sfdx plugins:install sfdx-git-delta@${{ env.DEV_CHANNEL }}
$ sf plugins install sfdx-git-delta@${{ env.DEV_CHANNEL }}
```
comment_tag: dev-publish
mode: delete
4 changes: 2 additions & 2 deletions .github/workflows/on-published-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
Shipped in [release `{release_tag}`]({release_link}).
You can install the new version using the version number or the `latest-rc` channel
```sh
$ sfdx plugins:install sfdx-git-delta@latest-rc
$ sfdx plugins:install sfdx-git-delta@{release_tag}
$ sf plugins install sfdx-git-delta@latest-rc
$ sf plugins install sfdx-git-delta@{release_tag}
```
Happy incremental deployment!
2 changes: 1 addition & 1 deletion .github/workflows/on-pull-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ jobs:
message: |
Published under `${{ env.DEV_CHANNEL }}` npm channel.
```sh
$ sfdx plugins:install sfdx-git-delta@${{ env.DEV_CHANNEL }}
$ sf plugins install sfdx-git-delta@${{ env.DEV_CHANNEL }}
```
comment_tag: dev-publish
mode: recreate
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/run-e2e-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@ jobs:
run: npm install -g ${{ matrix.cli }}

- name: Install new plugin version
run: echo y | sfdx plugins:install sfdx-git-delta@${{ inputs.channel }}
run: echo y | sf plugins install sfdx-git-delta@${{ inputs.channel }}

- name: Test new plugin version
run: sfdx sgd:source:delta --help
run: sf sgd source delta --help

- name: E2E Tests
run: |
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Then execute:
# remove expected content
yarn clean
# run the test
sfdx sgd:source:delta --from "e2e/base" --to "e2e/head" --output "expected" -d
sf sgd source delta --from "e2e/base" --to "e2e/head" --output "expected" --generate-delta
# check expected is back to normal
yarn test:e2e
```
Expand Down Expand Up @@ -238,5 +238,5 @@ When the character you should take for the short parameter is already taken then
To test SGD as a Salesforce CLI plugin from a pending pull request:

1. locate the comment with the beta version published in the pull request
2. install the beta version `sfdx plugins:install sfdx-git-delta@<beta-channel>`
2. install the beta version `sf plugins install sfdx-git-delta@<beta-channel>`
3. test the plugin!

0 comments on commit ded5517

Please sign in to comment.