Skip to content
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.

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

chore: Prerelease updates for v3.0.0 #142

Merged
merged 1 commit into from
Feb 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .tool-versions
Original file line number Diff line number Diff line change
@@ -1 +1 @@
nodejs 20.18.1
nodejs 20.18.2
63 changes: 45 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ $ heroku plugins:install @heroku-cli/plugin-addons-admin
$ npm install -g @heroku-cli/plugin-addons-admin
$ heroku COMMAND
running command...
$ heroku (-v|--version|version)
@heroku-cli/plugin-addons-admin/2.4.0 darwin-x64 node-v16.20.2
$ heroku (--version)
@heroku-cli/plugin-addons-admin/2.4.0 darwin-x64 node-v20.18.2
$ heroku --help [COMMAND]
USAGE
$ heroku COMMAND
Expand All @@ -42,7 +42,7 @@ Follow the [Developing CLI Plugins](https://devcenter.heroku.com/articles/develo
<!-- commands -->
* [`heroku addons:admin:manifest:diff`](#heroku-addonsadminmanifestdiff)
* [`heroku addons:admin:manifest:generate`](#heroku-addonsadminmanifestgenerate)
* [`heroku addons:admin:manifest:pull [SLUG]`](#heroku-addonsadminmanifestpull-slug)
* [`heroku addons:admin:manifest:pull SLUG`](#heroku-addonsadminmanifestpull-slug)
* [`heroku addons:admin:manifest:push`](#heroku-addonsadminmanifestpush)
* [`heroku addons:admin:manifests [SLUG]`](#heroku-addonsadminmanifests-slug)
* [`heroku addons:admin:manifests:info [SLUG]`](#heroku-addonsadminmanifestsinfo-slug)
Expand All @@ -55,6 +55,9 @@ compares remote manifest to local manifest and finds differences
```
USAGE
$ heroku addons:admin:manifest:diff

DESCRIPTION
compares remote manifest to local manifest and finds differences
```

_See code: [src/commands/addons/admin/manifest/diff.ts](https://github.com/heroku/heroku-cli-addons-admin/blob/v2.4.0/src/commands/addons/admin/manifest/diff.ts)_
Expand All @@ -65,31 +68,37 @@ generate a manifest template

```
USAGE
$ heroku addons:admin:manifest:generate
$ heroku addons:admin:manifest:generate [-a <value>] [-s <value>]

FLAGS
-a, --addon=<value> add-on name (name displayed on addon dashboard)
-s, --slug=<value> slugname/manifest id

OPTIONS
-a, --addon=addon add-on name (name displayed on addon dashboard)
-s, --slug=slug slugname/manifest id
DESCRIPTION
generate a manifest template

EXAMPLE
EXAMPLES
$ heroku addons:admin:generate
The file has been saved!
```

_See code: [src/commands/addons/admin/manifest/generate.ts](https://github.com/heroku/heroku-cli-addons-admin/blob/v2.4.0/src/commands/addons/admin/manifest/generate.ts)_

## `heroku addons:admin:manifest:pull [SLUG]`
## `heroku addons:admin:manifest:pull SLUG`

pull a manifest for a given slug

```
USAGE
$ heroku addons:admin:manifest:pull [SLUG]
$ heroku addons:admin:manifest:pull SLUG

ARGUMENTS
SLUG slug name of add-on

EXAMPLE
DESCRIPTION
pull a manifest for a given slug

EXAMPLES
$ heroku addons:admin:manifest:pull testing-123
...
Fetching add-on manifest for testing-123... done
Expand All @@ -106,7 +115,10 @@ update remote manifest
USAGE
$ heroku addons:admin:manifest:push

EXAMPLE
DESCRIPTION
update remote manifest

EXAMPLES
$ heroku addons:admin:manifest:push
...
Pushing manifest... done
Expand All @@ -122,6 +134,12 @@ list manifest history
```
USAGE
$ heroku addons:admin:manifests [SLUG]

ARGUMENTS
SLUG slug name of add-on

DESCRIPTION
list manifest history
```

_See code: [src/commands/addons/admin/manifests.ts](https://github.com/heroku/heroku-cli-addons-admin/blob/v2.4.0/src/commands/addons/admin/manifests.ts)_
Expand All @@ -132,10 +150,16 @@ show an individual history manifest

```
USAGE
$ heroku addons:admin:manifests:info [SLUG]
$ heroku addons:admin:manifests:info [SLUG] -m <value>

ARGUMENTS
SLUG slug name of add-on

FLAGS
-m, --manifest=<value> (required) manifest history id

OPTIONS
-m, --manifest=manifest (required) manifest history id
DESCRIPTION
show an individual history manifest
```

_See code: [src/commands/addons/admin/manifests/info.ts](https://github.com/heroku/heroku-cli-addons-admin/blob/v2.4.0/src/commands/addons/admin/manifests/info.ts)_
Expand All @@ -151,10 +175,13 @@ USAGE
ARGUMENTS
SLUG slug name of add-on

EXAMPLE
DESCRIPTION
open add-on dashboard

EXAMPLES
$ heroku addons:admin:open
Checking addon-manifest.json... done
Opening https://addons-next.heroku.com/addons/testing-123... done
Checking addon-manifest.json... done
Opening https://addons-next.heroku.com/addons/testing-123... done
```

_See code: [src/commands/addons/admin/open.ts](https://github.com/heroku/heroku-cli-addons-admin/blob/v2.4.0/src/commands/addons/admin/open.ts)_
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
"eslint-config-oclif-typescript": "^3.0.26",
"mocha": "^10.7.3",
"nock": "^13.5.6",
"np": "^10.2.0",
"nyc": "^17.1.0",
"oclif": "4.14.36",
"sinon": "^18.0.0",
Expand All @@ -47,8 +48,7 @@
},
"files": [
"/lib",
"/oclif.manifest.json",
"/yarn.lock"
"/oclif.manifest.json"
],
"homepage": "https://github.com/heroku/heroku-cli-addons-admin",
"keywords": [
Expand Down
Loading
Loading