Skip to content

Commit

Permalink
feat: improve parameters usage description (#382)
Browse files Browse the repository at this point in the history
* feat: improve parameters usage description

* docs: update publishing documentation

* build: make version alias a choice list

* fix: version-alias description typo

Co-authored-by: Mehdi Cherfaoui <mcherfaoui@salesforce.com>

Co-authored-by: Mehdi Cherfaoui <mcherfaoui@salesforce.com>
  • Loading branch information
scolladon and mcherfaouiSFDC authored Nov 4, 2022
1 parent d5bd9ca commit deeb5d1
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 14 deletions.
19 changes: 11 additions & 8 deletions .github/workflows/manage-versions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,19 @@ name: Manage Versions
on:
workflow_dispatch:
inputs:
source:
description: 'version number or alias to change from'
version-number:
description: 'source version number to use'
required: true
default: 'latest-rc'
default: 'vX.Y.Z'
type: string
target:
description: 'version number or alias to change to'
version-alias:
description: 'version alias to map to the source version'
required: true
default: 'latest'
type: string
type: choice
options:
- stable
- latest
- latest-rc

jobs:
add-tag:
Expand All @@ -28,6 +31,6 @@ jobs:
registry-url: https://registry.npmjs.org/

- name: Change version
run: npm dist-tag add "sfdx-git-delta@${{ github.event.inputs.source }}" "${{ github.event.inputs.target }}"
run: npm dist-tag add "sfdx-git-delta@${{ github.event.inputs.version-number }}" "${{ github.event.inputs.version-alias }}"
env:
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
12 changes: 6 additions & 6 deletions PUBLISHING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,16 @@ $ yarn npm tag add sfdx-git-delta@<version-source> <version-target>

It will set the version-source release channel to the version-target.

**Update `latest` to be `latest-rc`:**
This will update the SGD version most users get. The `latest` version is the one installed by default with the `sfdx plugins:install sfdx-git-delta` command.
**Update `v5.6.0` to be `latest`:**
To be performed once the current `latest-rc` version (`v5.6.0` at taht time) is considered stable enough. The `latest` version is the one installed by default with the `sfdx plugins:install sfdx-git-delta` command.
```sh
$ yarn npm tag add sfdx-git-delta@latest-rc latest
$ yarn npm tag add sfdx-git-delta@v5.6.0 latest
```

**Update `stable` to be `latest`:**
To be performed once the current `latest` version is considered stable enough.
**Update `v5.5.0` to be `stable`:**
To be performed once the current `latest` version (`v.5.5.0` at that time) is considered stable enough.
```sh
$ yarn npm tag add sfdx-git-delta@latest stable
$ yarn npm tag add sfdx-git-delta@v5.5.0 stable
```

**Rollback**:
Expand Down

0 comments on commit deeb5d1

Please sign in to comment.