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

Upgrade dependencies #578

Closed
wants to merge 173 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
173 commits
Select commit Hold shift + click to select a range
d7ebb19
Add link to Bump CLI help center
Polo2 Jul 1, 2021
8e3c403
Adapt Readme to version 2.1.1
Polo2 Aug 10, 2021
e71ada5
build(deps-dev): bump @types/debug from 4.1.6 to 4.1.7
dependabot[bot] Dec 28, 2021
c46b0b8
WIP: trying to migrate to full @oclif/core package
paulRbr Feb 10, 2022
3c37601
diff: display markdown in console
paulRbr Jan 18, 2022
daf50d3
fix: make sure to send posix-style paths to Bump servers
paulRbr Oct 18, 2022
0d26850
build(deps-dev): bump sinon from 11.1.1 to 15.0.1
dependabot[bot] Dec 16, 2022
710c56e
build(deps): bump tslib from 2.3.0 to 2.5.0
dependabot[bot] Jan 27, 2023
5c11bc8
build(deps-dev): bump prettier from 2.3.2 to 2.8.4
dependabot[bot] Feb 8, 2023
1de1062
Adapt Readme file with version 2.5.0
Polo2 Feb 17, 2023
af2aa79
Copywriting suggestion for main commands names
Polo2 Feb 17, 2023
cd68c64
build(deps-dev): bump @oclif/test from 1.2.8 to 2.3.9
dependabot[bot] Mar 6, 2023
0323524
Adapt CLI to receive 402 status from Bump API
Polo2 May 23, 2023
1d56c04
change install command beacuse -g is deprecated
fbraure Jun 5, 2023
f565842
build(deps): bump @apidevtools/json-schema-ref-parser
dependabot[bot] Oct 3, 2023
fd4f6b0
build(deps-dev): bump globby from 11.1.0 to 14.0.0
dependabot[bot] Nov 10, 2023
bc97d6b
build(deps-dev): bump typescript from 4.5.5 to 5.3.3
dependabot[bot] Dec 7, 2023
db0725a
WIP: adding an 'overlay' command to be able to apply OAS overlays
paulRbr Dec 13, 2023
692cef9
core: upgrade to TS 4.9 and change module type to 'nodenext'
paulRbr Dec 18, 2023
715dbbf
WIP: Tentative to run dev package
paulRbr Dec 18, 2023
66032c1
build(deps): bump @oclif/core from 1.20.4 to 3.15.1
dependabot[bot] Dec 25, 2023
5715cd8
WIP: adding an 'overlay' command to be able to apply OAS overlays
paulRbr Dec 13, 2023
a96a737
v2.7.3-beta.1
paulRbr Dec 28, 2023
4ffc085
tests: allow beta versions of the CLI in user agent spec
paulRbr Dec 29, 2023
47fdef3
build(deps-dev): bump @oclif/test from 2.1.0 to 3.1.8
dependabot[bot] Jan 1, 2024
d07b22c
docs: fix github action links
philsturgeon Jan 8, 2024
c74e81e
Merge branch 'adapt-Readme-to-v2.1.1'
skanda890 Jul 12, 2024
3bb08f0
build(deps-dev): bump @types/node from 15.14.9 to 17.0.4
dependabot[bot] Dec 23, 2021
0735cca
build(deps-dev): bump nock from 13.2.1 to 13.2.2
dependabot[bot] Jan 12, 2022
7b2a76f
fix: upgrade @oclif/plugin-help from 5.1.12 to 5.2.20
snyk-bot Jun 28, 2024
7d43e13
fix: upgrade @apidevtools/json-schema-ref-parser from 9.0.9 to 9.1.2
snyk-bot Jun 28, 2024
ba75a38
fix: upgrade oas-schemas from 2.0.0 to 2.1.3
snyk-bot Jun 28, 2024
6fa3586
fix: upgrade axios from 1.6.4 to 1.7.2
snyk-bot Jun 28, 2024
e572b19
fix: upgrade async-mutex from 0.4.0 to 0.5.0
snyk-bot Jun 29, 2024
ae1cf32
fix: upgrade @clack/prompts from 0.6.3 to 0.7.0
snyk-bot Jun 29, 2024
0462629
fix: upgrade debug from 4.3.4 to 4.3.5
snyk-bot Jun 29, 2024
78d944c
Revert "[Snyk] Upgrade async-mutex from 0.4.0 to 0.5.0"
skanda890 Jun 29, 2024
a4ce545
Revert "Revert "[Snyk] Upgrade async-mutex from 0.4.0 to 0.5.0""
skanda890 Jun 29, 2024
0a86244
Update README.md
skanda890 Jun 29, 2024
e416184
Update package.json
skanda890 Jun 29, 2024
fa92231
Adapt CLI to receive 402 status from Bump API
Polo2 May 23, 2023
105ee20
change install command beacuse -g is deprecated
fbraure Jun 5, 2023
df3df46
Add link to Bump CLI help center
Polo2 Jul 1, 2021
424ba2b
Adapt Readme file with version 2.5.0
Polo2 Feb 17, 2023
4abf92a
Copywriting suggestion for main commands names
Polo2 Feb 17, 2023
5bddb73
build(deps): bump @apidevtools/json-schema-ref-parser
dependabot[bot] Oct 3, 2023
0aa106d
build(deps): bump @oclif/core from 1.20.4 to 3.15.1
dependabot[bot] Dec 25, 2023
c882e73
build(deps-dev): bump @oclif/test from 2.1.0 to 3.1.8
dependabot[bot] Jan 1, 2024
46735e4
fix: package.json & package-lock.json to reduce vulnerabilities
snyk-bot Jul 12, 2024
3e79426
fix: package.json & package-lock.json to reduce vulnerabilities
snyk-bot Jul 12, 2024
f81cf80
build(deps-dev): bump globby from 11.1.0 to 14.0.0
dependabot[bot] Nov 10, 2023
d47b2a2
build(deps-dev): bump typescript from 4.5.5 to 5.3.3
dependabot[bot] Dec 7, 2023
aeecdab
fix: package.json & package-lock.json to reduce vulnerabilities
snyk-bot Jul 13, 2024
e535f02
fix: package.json & package-lock.json to reduce vulnerabilities
snyk-bot Jul 13, 2024
8996ce6
fix: upgrade axios from 1.6.3 to 1.7.2
snyk-bot Jul 13, 2024
dbd19c2
fix: upgrade @oclif/core from 3.15.1 to 3.27.0
snyk-bot Jul 14, 2024
3a60dfa
fix: upgrade async-mutex from 0.4.0 to 0.5.0
snyk-bot Jul 14, 2024
c4b5d74
fix: upgrade oas-schemas from 2.0.0 to 2.1.3
snyk-bot Jul 14, 2024
8ea1909
fix: upgrade @oclif/command from 1.8.18 to 1.8.36
snyk-bot Jul 14, 2024
6969071
fix: upgrade @oclif/plugin-help from 5.1.12 to 5.2.20
snyk-bot Jul 14, 2024
8e28ab1
fix: upgrade debug from 4.3.4 to 4.3.5
snyk-bot Jul 16, 2024
7aa2ffa
fix: upgrade @clack/prompts from 0.6.3 to 0.7.0
snyk-bot Jul 16, 2024
a6af63e
Update README.md
skanda890 Jul 17, 2024
7cc7c87
build(deps-dev): bump @types/node from 15.14.9 to 17.0.4
dependabot[bot] Dec 23, 2021
dee83a9
build(deps-dev): bump nock from 13.2.1 to 13.2.2
dependabot[bot] Jan 12, 2022
6ef5a14
fix: upgrade @oclif/plugin-help from 5.1.12 to 5.2.20
snyk-bot Jun 28, 2024
750aa84
fix: upgrade @apidevtools/json-schema-ref-parser from 9.0.9 to 9.1.2
snyk-bot Jun 28, 2024
7c57e17
fix: upgrade oas-schemas from 2.0.0 to 2.1.3
snyk-bot Jun 28, 2024
6fe03f7
fix: upgrade axios from 1.6.4 to 1.7.2
snyk-bot Jun 28, 2024
8e823ab
fix: upgrade async-mutex from 0.4.0 to 0.5.0
snyk-bot Jun 29, 2024
90b017b
fix: upgrade @clack/prompts from 0.6.3 to 0.7.0
snyk-bot Jun 29, 2024
7e2c7e9
fix: upgrade debug from 4.3.4 to 4.3.5
snyk-bot Jun 29, 2024
2e903ac
Revert "[Snyk] Upgrade async-mutex from 0.4.0 to 0.5.0"
skanda890 Jun 29, 2024
ebd4bad
Revert "Revert "[Snyk] Upgrade async-mutex from 0.4.0 to 0.5.0""
skanda890 Jun 29, 2024
6d07a53
Update README.md
skanda890 Jun 29, 2024
b056538
Adapt CLI to receive 402 status from Bump API
Polo2 May 23, 2023
9e38874
change install command beacuse -g is deprecated
fbraure Jun 5, 2023
de2d849
Add link to Bump CLI help center
Polo2 Jul 1, 2021
c6a4a27
Adapt Readme file with version 2.5.0
Polo2 Feb 17, 2023
c812331
Copywriting suggestion for main commands names
Polo2 Feb 17, 2023
090149b
build(deps): bump @apidevtools/json-schema-ref-parser
dependabot[bot] Oct 3, 2023
a95beaa
build(deps): bump @oclif/core from 1.20.4 to 3.15.1
dependabot[bot] Dec 25, 2023
e993055
build(deps-dev): bump @oclif/test from 2.1.0 to 3.1.8
dependabot[bot] Jan 1, 2024
208ea1d
fix: package.json & package-lock.json to reduce vulnerabilities
snyk-bot Jul 12, 2024
e3b4738
fix: package.json & package-lock.json to reduce vulnerabilities
snyk-bot Jul 12, 2024
604aceb
build(deps-dev): bump globby from 11.1.0 to 14.0.0
dependabot[bot] Nov 10, 2023
ce116b0
build(deps-dev): bump typescript from 4.5.5 to 5.3.3
dependabot[bot] Dec 7, 2023
5ff201e
fix: package.json & package-lock.json to reduce vulnerabilities
snyk-bot Jul 13, 2024
356826a
fix: package.json & package-lock.json to reduce vulnerabilities
snyk-bot Jul 13, 2024
28409a9
fix: upgrade axios from 1.6.3 to 1.7.2
snyk-bot Jul 13, 2024
382f6e4
fix: upgrade @oclif/core from 3.15.1 to 3.27.0
snyk-bot Jul 14, 2024
7244ad0
fix: upgrade async-mutex from 0.4.0 to 0.5.0
snyk-bot Jul 14, 2024
48488dd
fix: upgrade oas-schemas from 2.0.0 to 2.1.3
snyk-bot Jul 14, 2024
f67888a
fix: upgrade @oclif/command from 1.8.18 to 1.8.36
snyk-bot Jul 14, 2024
e2a3ad3
fix: upgrade @oclif/plugin-help from 5.1.12 to 5.2.20
snyk-bot Jul 14, 2024
5859898
fix: upgrade debug from 4.3.4 to 4.3.5
snyk-bot Jul 16, 2024
5023607
fix: upgrade @clack/prompts from 0.6.3 to 0.7.0
snyk-bot Jul 16, 2024
b1a34c6
Update README.md
skanda890 Jul 17, 2024
087444a
Merge pull request #36 from skanda890/OMain
skanda890 Jul 17, 2024
4a5a9a7
Merge remote-tracking branch 'upstream/Adapt-CLI-to-support-error-402'
skanda890 Jul 18, 2024
867c28c
Merge branch 'philsturgeon-adapt-Readme-to-v2.1.1'
skanda890 Jul 18, 2024
7a647c2
Merge remote-tracking branch 'upstream/add-link-to-bump-CI-help-center'
skanda890 Jul 20, 2024
254b510
Merge remote-tracking branch 'upstream/change_global_option_in_readme'
skanda890 Jul 20, 2024
c49833b
Merge remote-tracking branch 'upstream/copywrite--suggestions'
skanda890 Jul 20, 2024
0649f86
Merge remote-tracking branch 'upstream/dependabot/npm_and_yarn/apidev…
skanda890 Jul 20, 2024
054189d
Merge remote-tracking branch 'upstream/dependabot/npm_and_yarn/globby…
skanda890 Jul 20, 2024
72fb67d
Merge remote-tracking branch 'upstream/dependabot/npm_and_yarn/oclif/…
skanda890 Jul 20, 2024
d7c8cf2
fix: package.json & package-lock.json to reduce vulnerabilities
snyk-bot Jul 20, 2024
913b674
Merge branch 'main' into snyk-fix-ad09b6f8559e6356a742f81075568460
skanda890 Jul 20, 2024
137cf63
Merge pull request #37 from skanda890/snyk-fix-ad09b6f8559e6356a742f8…
skanda890 Jul 20, 2024
ea52658
Merge branch 'pr/38'
skanda890 Jul 20, 2024
5cdba43
Merge branch 'main' of https://github.com/skanda890/Cli
skanda890 Jul 20, 2024
5200401
fix: package.json & package-lock.json to reduce vulnerabilities
snyk-bot Jul 20, 2024
9def28e
Merge pull request #40 from paulRbr/send-posix-paths-to-bump
skanda890 Jul 20, 2024
cfe0314
Merge pull request #39 from skanda890/snyk-fix-0a02ac19a0fa6cd99cbaec…
skanda890 Jul 20, 2024
d5c9398
Merge branch 'pr/41'
skanda890 Jul 20, 2024
301642d
Merge branch 'main' of https://github.com/skanda890/Cli
skanda890 Jul 20, 2024
577c8f2
Merge branch 'pr/42'
skanda890 Jul 20, 2024
c90148f
Merge branch 'pr/43'
skanda890 Jul 20, 2024
e217952
fix: package.json & package-lock.json to reduce vulnerabilities
snyk-bot Jul 20, 2024
4a6ee68
Merge pull request #45 from paulRbr/dependabot/npm_and_yarn/tslib-2.5.0
skanda890 Jul 20, 2024
5d5a3ac
Merge branch 'main' into snyk-fix-9ade37130a49377c6f52a1bc31e91b6b
skanda890 Jul 20, 2024
dcaee0b
Merge pull request #44 from skanda890/snyk-fix-9ade37130a49377c6f52a1…
skanda890 Jul 20, 2024
3d28724
fix: package.json & package-lock.json to reduce vulnerabilities
snyk-bot Jul 20, 2024
0c5bc1f
Merge pull request #46 from skanda890/snyk-fix-9df7671f0bcd69d864038c…
skanda890 Jul 20, 2024
2d0d088
fix: package.json & package-lock.json to reduce vulnerabilities
snyk-bot Jul 20, 2024
c799925
Merge pull request #48 from skanda890/snyk-fix-860eb73053765cff4658f2…
skanda890 Jul 20, 2024
ef33f6a
fix: package.json & package-lock.json to reduce vulnerabilities
snyk-bot Jul 20, 2024
aa60814
Merge branch 'pr/47'
skanda890 Jul 20, 2024
a4f1f42
fix: package.json & package-lock.json to reduce vulnerabilities
snyk-bot Jul 20, 2024
b7a541b
Merge branch 'main' into snyk-fix-5da4df6faeda60c13c2feb747ede3c57
skanda890 Jul 20, 2024
700dd25
Merge pull request #51 from skanda890/snyk-fix-5da4df6faeda60c13c2feb…
skanda890 Jul 20, 2024
7bd79e8
Merge branch 'main' into snyk-fix-9a902c8d0fdd79a29a9dc7578ac377d6
skanda890 Jul 20, 2024
9725681
Merge pull request #52 from skanda890/snyk-fix-9a902c8d0fdd79a29a9dc7…
skanda890 Jul 20, 2024
32b3908
Merge branch 'pr/50'
skanda890 Jul 20, 2024
f531b8d
Merge branch 'main' of https://github.com/skanda890/Cli
skanda890 Jul 20, 2024
b29cef4
Merge branch 'pr/49'
skanda890 Jul 20, 2024
4d052b2
Merge branch 'pr/53'
skanda890 Jul 20, 2024
8d9eb6c
Merge branch 'pr/56'
skanda890 Jul 20, 2024
5722adf
Merge branch 'pr/55'
skanda890 Jul 20, 2024
59a1f03
Merge branch 'pr/54'
skanda890 Jul 20, 2024
e671860
fix: upgrade @oclif/command from 1.8.18 to 1.8.36
snyk-bot Jul 22, 2024
2e39979
fix: upgrade @oclif/config from 1.18.3 to 1.18.17
snyk-bot Jul 22, 2024
63566c1
fix: upgrade @oclif/core from 1.20.4 to 1.26.2
snyk-bot Jul 22, 2024
9178950
fix: upgrade tslib from 2.5.0 to 2.6.3
snyk-bot Jul 22, 2024
1ed3340
Merge pull request #61 from skanda890/snyk-upgrade-4dd1a8bce2f7d6f678…
skanda890 Jul 22, 2024
177b609
Merge pull request #60 from skanda890/snyk-upgrade-c359f67d22a5b34304…
skanda890 Jul 22, 2024
6f445b4
Merge pull request #58 from skanda890/snyk-upgrade-012ee973fdea93ebb6…
skanda890 Jul 22, 2024
61b5135
Merge branch 'main' into snyk-upgrade-59c3ad26178674ca1a592c8867531743
skanda890 Jul 22, 2024
fd2c5ba
Merge pull request #59 from skanda890/snyk-upgrade-59c3ad26178674ca1a…
skanda890 Jul 22, 2024
3f80311
main (#63)
skanda890 Aug 12, 2024
24213ea
Revert "main (#63)" (#64)
skanda890 Aug 12, 2024
297e4f7
build(deps): bump @apidevtools/json-schema-ref-parser (#65)
skanda890 Aug 12, 2024
8e324ea
fix: package.json & package-lock.json to reduce vulnerabilities (#66)
skanda890 Aug 12, 2024
20b95fc
skanda890 (#67)
skanda890 Aug 12, 2024
f1b742c
New branch name (#68)
skanda890 Aug 12, 2024
951e33b
New branch name (#69)
skanda890 Aug 12, 2024
41187f2
readme: add documentation about the `--fail-on-breaking` flag
paulRbr Aug 1, 2024
3534f0f
fix(overlay): backport of an upstream fix for remove action
paulRbr Aug 2, 2024
2441f4f
2.8.2
paulRbr Aug 5, 2024
a83cd0b
Update Package.json and Package-lock.json
skanda890 Aug 12, 2024
4cb16bf
readme: add documentation about the `--fail-on-breaking` flag
paulRbr Aug 1, 2024
f066816
fix(overlay): backport of an upstream fix for remove action
paulRbr Aug 2, 2024
cc0a4ae
main (#63)
skanda890 Aug 12, 2024
84a77a7
Revert "main (#63)" (#64)
skanda890 Aug 12, 2024
4e96508
fix: package.json & package-lock.json to reduce vulnerabilities (#66)
skanda890 Aug 12, 2024
8654797
skanda890 (#67)
skanda890 Aug 12, 2024
e950879
New branch name (#68)
skanda890 Aug 12, 2024
0530886
Update
skanda890 Aug 12, 2024
7b645d1
Update package.json
skanda890 Aug 12, 2024
0711b86
Merge branch 'main' of https://github.com/skanda890/Cli
skanda890 Aug 12, 2024
ca46abf
Update
skanda890 Aug 12, 2024
185fd78
build(deps): bump axios in the npm_and_yarn group across 1 directory …
dependabot[bot] Aug 14, 2024
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
51 changes: 12 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<a href="https://bump.sh/users/sign_up">Sign up</a>
</p>

The Bump.sh CLI is used to interact with your API documentation or hubs hosted on Bump.sh. With any API definition of your choice (from Swagger, OpenAPI or AsyncAPI), it can help you to:
The Bump.sh CLI is used to interact with your API documentation or hubs hosted on Bump.sh. With any API definition of your choice (from Swagger, OpenAPI, or AsyncAPI), it can help you to:

- Validate an API document before publishing it to your documentation
- Publish an API document to your Bump.sh documentation or hubs
Expand All @@ -32,9 +32,8 @@ Under the hood, it uses the API of [developers.bump.sh](https://developers.bump.

## Installation

The Bump.sh CLI is a node package currently distributed via NPM. This means you must have the Node v14+ interpreter installed on your computer or CI servers.

_If you are looking to use Bump.sh in a continuous integration environment you might be interested by [our Github Action](https://github.com/marketplace/actions/api-documentation-on-bump)._
The Bump.sh CLI is a node package currently distributed via NPM. You must have the Node v14+ interpreter installed on your computer or CI servers.
_If you are looking to use Bump.sh in a continuous integration environment you might be interested in [our GitHub Action](https://github.com/marketplace/actions/bump-sh)._

> You can download a standalone package directly from the latest
> GitHub release assets if you don’t use Node.
Expand All @@ -56,7 +55,7 @@ yarn global add bump-cli

### Add Bump.sh to your node project

As our CLI is a node package, you can easily embed it into your project by adding the package to your `package.json` file, either with NPM
As our CLI is a node package, you can easily embed it to your project by adding the package to your `package.json` file, either with NPM

```sh-session
npm install --save-dev bump-cli
Expand All @@ -74,7 +73,7 @@ You can then use any Bump.sh commands with `npx` (same as `npm exec`)
npx bump --help
```

### How should I do if I'm not using npm ?
### How should I do if I'm not using npm?

Unfortunately, at the moment we only support the Node environment. However, you can download a standalone package directly from the [latest Github release](https://github.com/bump-sh/cli/releases) assets which you can run as a standalone binary. Or you can push your documentation using [our API](https://developers.bump.sh/) (advanced usage only).

Expand All @@ -87,7 +86,7 @@ $ bump --help
The Bump.sh CLI is used to interact with your API documentation hosted on Bump.sh by using the API of developers.bump.sh

VERSION
bump-cli/2.8.0 linux-x64 node-v16.19.0
bump-cli/2.7.2 linux-x64 node-v16.17.0

USAGE
$ bump [COMMAND]
Expand All @@ -96,7 +95,6 @@ COMMANDS
deploy Create a new version of your documentation from the given file or URL.
diff Get a comparison diff with your documentation from the given file or URL.
help Display help for bump.
overlay Apply an OpenAPI specified overlay to your API definition.
preview Create a documentation preview from the given file or URL.
```

Expand All @@ -113,7 +111,6 @@ Head over to your Documentation settings in the “CI deployment” section or y
* [`bump deploy [FILE]`](#bump-deploy-file)
* [`bump diff [FILE]`](#bump-diff-file)
* [`bump preview [FILE]`](#bump-preview-file)
* [`bump overlay [DEFINITION_FILE] [OVERLAY_FILE]`](#bump-overlay-definition_file-overlay_file)

### `bump deploy [FILE]`

Expand All @@ -123,7 +120,7 @@ When you update your API, you also want its documentation to be up to date for y
bump deploy path/to/api-document.yml --doc my-documentation --token $DOC_TOKEN
```

> You can find your own `my-documentation` slug and `$DOC_TOKEN` api key from your [documentation settings](https://bump.sh/docs).
> You can find your own `my-documentation` slug and `$DOC_TOKEN` API key from your [documentation settings](https://bump.sh/docs).
{: .info}

You can also deploy a given API document to a different branch of your documentation with the `--branch <branch-name>` parameter. Please note the branch will be created if it doesn’t exist. More details about the branching feature are available on [this dedicated help page](https://docs.bump.sh/help/branching). E.g. deploy the API document to the `staging` branch of the documentation:
Expand All @@ -140,7 +137,7 @@ If you already have a hub in your [Bump.sh](https://bump.sh) account, you can au
bump deploy dir/path/to/apis/ --auto-create --hub my-hub --token $HUB_TOKEN
```

> You can find your own `my-hub` slug and `$HUB_TOKEN` api key from your [hub settings](https://bump.sh/hubs).
> You can find your own `my-hub` slug and `$HUB_TOKEN` API key from your [hub settings](https://bump.sh/hubs).
{: .info}

Please note, by default, only files named `{slug}-api.[format]` are published. Where `{slug}` is a name for your API and `[format]` is either `yaml` or `json`. Adjust to your file naming convention using the `--filename-pattern <pattern>` option.
Expand All @@ -158,7 +155,7 @@ path/to/apis
└─ README.md
```

In order to deploy the 3 services API definition files from this folder (`private-api-users-service.json`, `partner-api-payments-service.yml` and `public-api-contracts-service.yml`), you can execute the following command:
To deploy the 3 services API definition files from this folder (`private-api-users-service.json`, `partner-api-payments-service.yml` and `public-api-contracts-service.yml`), you can execute the following command:

```
bump deploy path/to/apis/ --hub my-hub --filename-pattern '*-api-{slug}-service'
Expand All @@ -176,7 +173,7 @@ Please check `bump deploy --help` for more usage details.

### `bump diff [FILE]`

_If you want to receive automatic `bump diff` results on your Github Pull Requests you might be interested by [our Github Action](https://github.com/marketplace/actions/api-documentation-on-bump#api-diff-on-pull-requests) diff command._
_If you want to receive automatic `bump diff` results on your Github Pull Requests you might be interested by [our Github Action](https://github.com/marketplace/actions/bump-sh#diff-on-pull-requests-only) diff command._

Please note that by default the command will always exit with a
successful return code. If you want to use this command in a CI
Expand Down Expand Up @@ -244,7 +241,7 @@ bump preview --live --open openapi-definition.json
```

- Edit your `openapi-definition.json` file in your favorite text editor
- Watch the live preview being updated each time you save your file.
- Watch the live preview is updated each time you save your file.

> You can create as many previews as you like without being authenticated. This is a **free and unlimited service**.
{: .info}
Expand All @@ -253,26 +250,6 @@ _Note: the additional `--open` flag helps to automatically open the preview URL

Please check `bump preview --help` for more usage details

### `bump overlay [DEFINITION_FILE] [OVERLAY_FILE]`

> This feature implements the [OpenAPI Overlay specification](https://github.com/OAI/Overlay-Specification). It is possible to apply an Overlay to any kind of document, be it an OpenAPI or AsyncAPI definition file.

The Overlay specification of OpenAPI makes it possible to modify the content of an API definition file by adding a layer on top of it. That layer helps add, remove, or change some or all of the content of the original definition.

Technically, the `bump overlay` command will output a modified version of the `[DEFINITION_FILE]` (an OpenAPI or AsyncAPI document) by applying the operations described in the `[OVERLAY_FILE]` Overlay file to the original API document.

To redirect the output of the command to a new file you can run the following:

```shell
bump overlay api-document.yaml overlay-file.yaml > api-overlayed-document.yaml
```

_Note: you can also apply the overlay during the [`bump deploy` command]((#bump-deploy-file)) with the new `--overlay` flag:_

```shell
bump deploy api-document.yaml --doc my-doc --token my-token --overlay overlay-file.yaml
```

## Development

Make sure to have Node.js (At least v14) installed on your machine.
Expand Down Expand Up @@ -311,10 +288,6 @@ We currently support [OpenAPI](https://github.com/OAI/OpenAPI-Specification) fro

Bug reports and pull requests are welcome on GitHub at <https://github.com/bump-sh/cli>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## Thanks

- [Lorna Mitchel](https://github.com/lornajane/) for [openapi-overlay-js](https://github.com/lornajane/openapi-overlays-js)

## License

The Bump CLI project is released under the [MIT License](http://opensource.org/licenses/MIT).
Expand All @@ -327,6 +300,6 @@ Everyone interacting in the Bump-CLI project codebases, issue trackers, chat roo

This npm package starts at v2.0.0 for two main reasons:

- Our [first version](https://github.com/bump-sh/bump-cli) of the Bump CLI was written in Ruby, starting at v2.0.0, which makes it clear we are working on our second version of the Bump CLI
- Our [first version](https://github.com/bump-sh/bump-cli) of the Bump CLI was written in Ruby, starting at v2.0.0, makes it clear we are working on our second version of the Bump CLI

- The `bump-cli` package used to be [owned by Rico](https://github.com/rstacruz) which already published v1.x packages. If you are looking for the old npm package please head to [`@rstacruz/bump-cli` package](https://www.npmjs.com/package/@rstacruz/bump-cli). _A big thanks to Rico for transferring the ownership of the `bump-cli` package name!_
5 changes: 5 additions & 0 deletions bin/dev
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#!/usr/bin/env -S node --loader ts-node/esm

require('@oclif/command').run()
.then(require('@oclif/command/flush'))
.catch(require('@oclif/errors/handle'))
6 changes: 3 additions & 3 deletions bin/run
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/usr/bin/env node

require('@oclif/command').run()
.then(require('@oclif/command/flush'))
.catch(require('@oclif/errors/handle'))
const oclif = require('@oclif/core');

oclif.run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle'));
4 changes: 0 additions & 4 deletions examples/valid/overlay.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,6 @@ actions:
description: Remove all other servers so we can add our own.
remove: true

- target: '$..[?(@["x-beta"]==true)]'
description: Remove all beta operations
remove: true

- target: '$.servers'
description: Pop our server into the empty server array.
update:
Expand Down
Loading
Loading