Skip to content

chore: update docs to clarify hd update command #323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
KLongmuirHD merged 2 commits into from
Sep 5, 2025
Merged

chore: update docs to clarify hd update command #323

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb8e7da
chore: update docs to clarify hd update command
KLongmuirHD Sep 5, 2025
b67701f
chore: make oclif readme updates manual, update docs
KLongmuirHD Sep 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,17 @@

### Current Process (Branch-based Releases)

The CLI uses a branch-based release process. To create a release:
#### Updating the README

If you have made changes to available oclif commands or flags, run `npm run readme` to have oclif auto generate the new documentation.
Manual edits already made to auto generated README sections will be overwritten, so carefully review any changes
that oclif makes.


#### Create a release branch

The CLI uses a branch-based release process. To create a release:

1. `git fetch origin main`
2. `git switch main`
3. `git pull origin main`
Expand Down
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ USAGE
* [`hd help [COMMAND]`](#hd-help-command)
* [`hd scan eol`](#hd-scan-eol)
* [`hd update [CHANNEL]`](#hd-update-channel)
* Only applies to tarball installation. For NPM users, please update using `npm install`
Comment thread
KLongmuirHD marked this conversation as resolved.

## `hd help [COMMAND]`

Expand Down Expand Up @@ -83,13 +84,14 @@ Scan a given SBOM for EOL data

```
USAGE
$ hd scan eol [--json] [-f <value> | -d <value>] [-s] [--saveSbom]
$ hd scan eol [--json] [-f <value> | -d <value>] [-s] [--saveSbom] [--version]

FLAGS
-d, --dir=<value> [default: <current directory>] The directory to scan in order to create a cyclonedx SBOM
-f, --file=<value> The file path of an existing cyclonedx SBOM to scan for EOL
-s, --save Save the generated report as herodevs.report.json in the scanned directory
--saveSbom Save the generated SBOM as herodevs.sbom.json in the scanned directory
--version Show CLI version.

GLOBAL FLAGS
--json Format output as json.
Expand Down Expand Up @@ -124,6 +126,7 @@ _See code: [src/commands/scan/eol.ts](https://github.com/herodevs/cli/blob/v2.0.
## `hd update [CHANNEL]`

update the hd CLI
**NOTE:** Only applies to binary installation method. NPM users should use `npm install` to update to the latest version.

```
USAGE
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"test": "globstar -- node --import tsx --test --experimental-test-module-mocks \"test/**/*.test.ts\"",
"test:e2e": "globstar -- node --import tsx --test \"e2e/**/*.test.ts\"",
"typecheck": "tsc --noEmit",
"version": "oclif manifest && npm run readme"
"version": "oclif manifest"
},
"keywords": [
"herodevs",
Expand Down
Loading