Skip to content

Commit

Permalink
build(release): 🚀 v9.0.2 🦉
Browse files Browse the repository at this point in the history
## [9.0.2](v9.0.1...v9.0.2) (2024-12-11)

### Bug Fixes

* **autocomplete:** bad alias ([#1118](#1118)) ([5b8d928](5b8d928))
* remove import attributes ([#1117](#1117)) ([e662654](e662654)), closes [#1115](#1115) [/github.com//pull/1115#issuecomment-2532123627](https://github.com//github.com/readmeio/rdme/pull/1115/issues/issuecomment-2532123627)

[skip ci]
  • Loading branch information
semantic-release-bot committed Dec 11, 2024
1 parent ce3ab6a commit 7afc4d4
Show file tree
Hide file tree
Showing 10 changed files with 34 additions and 70 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
## [9.0.2](https://github.com/readmeio/rdme/compare/v9.0.1...v9.0.2) (2024-12-11)


### Bug Fixes

* **autocomplete:** bad alias ([#1118](https://github.com/readmeio/rdme/issues/1118)) ([5b8d928](https://github.com/readmeio/rdme/commit/5b8d9286e891b1bc5cfbcfce1a1862cb8dbdf2b4))
* remove import attributes ([#1117](https://github.com/readmeio/rdme/issues/1117)) ([e662654](https://github.com/readmeio/rdme/commit/e66265486cac80f79c79f8594b7c60862fadbe12)), closes [#1115](https://github.com/readmeio/rdme/issues/1115) [/github.com/readmeio/rdme/pull/1115#issuecomment-2532123627](https://github.com//github.com/readmeio/rdme/pull/1115/issues/issuecomment-2532123627)

## [9.0.2-next.2](https://github.com/readmeio/rdme/compare/v9.0.2-next.1...v9.0.2-next.2) (2024-12-10)


Expand Down
2 changes: 1 addition & 1 deletion dist-gha/commands.js

Large diffs are not rendered by default.

16 changes: 4 additions & 12 deletions documentation/commands/categories.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,7 @@ USAGE
$ rdme categories --key <value> [--version <value>]
FLAGS
--key=<value> (required) An API key for your ReadMe project. Note that API authentication is required despite
being omitted from the example usage. See our docs for more information:
https://github.com/readmeio/rdme/tree/v9#authentication
--key=<value> (required) ReadMe project API key
--version=<value> ReadMe project version
DESCRIPTION
Expand All @@ -29,13 +27,11 @@ EXAMPLES
$ rdme categories --version={project-version}
FLAG DESCRIPTIONS
--key=<value>
--key=<value> ReadMe project API key
An API key for your ReadMe project. Note that API authentication is required despite being omitted from the example
usage. See our docs for more information: https://github.com/readmeio/rdme/tree/v9#authentication
ReadMe project API key
--version=<value> ReadMe project version
If running command in a CI environment and this option is not passed, the main project version will be used. See our
Expand All @@ -56,9 +52,7 @@ ARGUMENTS
FLAGS
--categoryType=<option> (required) Category type
<options: guide|reference>
--key=<value> (required) An API key for your ReadMe project. Note that API authentication is required
despite being omitted from the example usage. See our docs for more information:
https://github.com/readmeio/rdme/tree/v9#authentication
--key=<value> (required) ReadMe project API key
--preventDuplicates Prevents the creation of a new category if there is an existing category with a matching
`categoryType` and `title`
--version=<value> ReadMe project version
Expand All @@ -78,13 +72,11 @@ EXAMPLES
--preventDuplicates
FLAG DESCRIPTIONS
--key=<value>
--key=<value> ReadMe project API key
An API key for your ReadMe project. Note that API authentication is required despite being omitted from the example
usage. See our docs for more information: https://github.com/readmeio/rdme/tree/v9#authentication
ReadMe project API key
--version=<value> ReadMe project version
If running command in a CI environment and this option is not passed, the main project version will be used. See our
Expand Down
8 changes: 2 additions & 6 deletions documentation/commands/changelogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,7 @@ ARGUMENTS
FLAGS
--dryRun Runs the command without creating/updating any changelogs in ReadMe. Useful for debugging.
--github Create a new GitHub Actions workflow for this command.
--key=<value> (required) An API key for your ReadMe project. Note that API authentication is required despite being
omitted from the example usage. See our docs for more information:
https://github.com/readmeio/rdme/tree/v9#authentication
--key=<value> (required) ReadMe project API key
DESCRIPTION
Sync Markdown files to your ReadMe project as Changelog posts.
Expand All @@ -42,10 +40,8 @@ EXAMPLES
$ rdme changelogs [path] --version={project-version} --dryRun
FLAG DESCRIPTIONS
--key=<value>
--key=<value> ReadMe project API key
An API key for your ReadMe project. Note that API authentication is required despite being omitted from the example
usage. See our docs for more information: https://github.com/readmeio/rdme/tree/v9#authentication
ReadMe project API key
```
8 changes: 2 additions & 6 deletions documentation/commands/custompages.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,7 @@ ARGUMENTS
FLAGS
--dryRun Runs the command without creating/updating any custom pages in ReadMe. Useful for debugging.
--github Create a new GitHub Actions workflow for this command.
--key=<value> (required) An API key for your ReadMe project. Note that API authentication is required despite being
omitted from the example usage. See our docs for more information:
https://github.com/readmeio/rdme/tree/v9#authentication
--key=<value> (required) ReadMe project API key
DESCRIPTION
Sync Markdown/HTML files to your ReadMe project as Custom Pages.
Expand All @@ -42,10 +40,8 @@ EXAMPLES
$ rdme custompages [path] --version={project-version} --dryRun
FLAG DESCRIPTIONS
--key=<value>
--key=<value> ReadMe project API key
An API key for your ReadMe project. Note that API authentication is required despite being omitted from the example
usage. See our docs for more information: https://github.com/readmeio/rdme/tree/v9#authentication
ReadMe project API key
```
16 changes: 4 additions & 12 deletions documentation/commands/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,7 @@ ARGUMENTS
FLAGS
--dryRun Runs the command without creating/updating any docs in ReadMe. Useful for debugging.
--github Create a new GitHub Actions workflow for this command.
--key=<value> (required) An API key for your ReadMe project. Note that API authentication is required despite
being omitted from the example usage. See our docs for more information:
https://github.com/readmeio/rdme/tree/v9#authentication
--key=<value> (required) ReadMe project API key
--version=<value> ReadMe project version
DESCRIPTION
Expand All @@ -47,13 +45,11 @@ EXAMPLES
$ rdme docs [path] --version={project-version} --dryRun
FLAG DESCRIPTIONS
--key=<value>
--key=<value> ReadMe project API key
An API key for your ReadMe project. Note that API authentication is required despite being omitted from the example
usage. See our docs for more information: https://github.com/readmeio/rdme/tree/v9#authentication
ReadMe project API key
--version=<value> ReadMe project version
If running command in a CI environment and this option is not passed, the main project version will be used. See our
Expand All @@ -75,9 +71,7 @@ FLAGS
--confirm Bypass the confirmation prompt. Useful for CI environments.
--dryRun Runs the command without deleting any docs in ReadMe. Useful for debugging.
--github Create a new GitHub Actions workflow for this command.
--key=<value> (required) An API key for your ReadMe project. Note that API authentication is required despite
being omitted from the example usage. See our docs for more information:
https://github.com/readmeio/rdme/tree/v9#authentication
--key=<value> (required) ReadMe project API key
--version=<value> ReadMe project version
DESCRIPTION
Expand All @@ -96,13 +90,11 @@ EXAMPLES
$ rdme docs prune [path-to-directory-of-markdown] --confirm
FLAG DESCRIPTIONS
--key=<value>
--key=<value> ReadMe project API key
An API key for your ReadMe project. Note that API authentication is required despite being omitted from the example
usage. See our docs for more information: https://github.com/readmeio/rdme/tree/v9#authentication
ReadMe project API key
--version=<value> ReadMe project version
If running command in a CI environment and this option is not passed, the main project version will be used. See our
Expand Down
8 changes: 2 additions & 6 deletions documentation/commands/openapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,7 @@ FLAGS
--github Create a new GitHub Actions workflow for this command.
--id=<value> Unique identifier for your API definition. Use this if you're re-uploading an existing API
definition.
--key=<value> (required) An API key for your ReadMe project. Note that API authentication is required
despite being omitted from the example usage. See our docs for more information:
https://github.com/readmeio/rdme/tree/v9#authentication
--key=<value> (required) ReadMe project API key
--raw Return the command results as a JSON object instead of a pretty output.
--title=<value> An override value for the `info.title` field in the API definition
--update Bypasses the create/update prompt and automatically updates an existing API definition in
Expand Down Expand Up @@ -99,13 +97,11 @@ EXAMPLES
$ rdme openapi [url-or-local-path-to-file] --version={project-version} --update
FLAG DESCRIPTIONS
--key=<value>
--key=<value> ReadMe project API key
An API key for your ReadMe project. Note that API authentication is required despite being omitted from the example
usage. See our docs for more information: https://github.com/readmeio/rdme/tree/v9#authentication
ReadMe project API key
--update Bypasses the create/update prompt and automatically updates an existing API definition in ReadMe.
Note that this flag only works if there's only one API definition associated with the current version.
Expand Down
32 changes: 8 additions & 24 deletions documentation/commands/versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@ USAGE
$ rdme versions --key <value> [--version <value>]
FLAGS
--key=<value> (required) An API key for your ReadMe project. Note that API authentication is required despite
being omitted from the example usage. See our docs for more information:
https://github.com/readmeio/rdme/tree/v9#authentication
--key=<value> (required) ReadMe project API key
--version=<value> A specific project version to view.
DESCRIPTION
Expand All @@ -35,12 +33,10 @@ EXAMPLES
$ rdme versions --version={project-version}
FLAG DESCRIPTIONS
--key=<value>
--key=<value> ReadMe project API key
An API key for your ReadMe project. Note that API authentication is required despite being omitted from the example
usage. See our docs for more information: https://github.com/readmeio/rdme/tree/v9#authentication
ReadMe project API key
```

## `rdme versions create VERSION`
Expand All @@ -64,9 +60,7 @@ FLAGS
--fork=<value> The semantic version which you'd like to fork from.
--hidden=<option> Should this version be hidden? The main version cannot be hidden.
<options: true|false>
--key=<value> (required) An API key for your ReadMe project. Note that API authentication is required despite
being omitted from the example usage. See our docs for more information:
https://github.com/readmeio/rdme/tree/v9#authentication
--key=<value> (required) ReadMe project API key
--main=<option> Should this be the main version for your project?
<options: true|false>
Expand All @@ -85,12 +79,10 @@ EXAMPLES
--deprecated={true|false} --hidden={true|false}
FLAG DESCRIPTIONS
--key=<value>
--key=<value> ReadMe project API key
An API key for your ReadMe project. Note that API authentication is required despite being omitted from the example
usage. See our docs for more information: https://github.com/readmeio/rdme/tree/v9#authentication
ReadMe project API key
```

## `rdme versions delete [VERSION]`
Expand All @@ -105,9 +97,7 @@ ARGUMENTS
VERSION The version you'd like to delete.
FLAGS
--key=<value> (required) An API key for your ReadMe project. Note that API authentication is required despite being
omitted from the example usage. See our docs for more information:
https://github.com/readmeio/rdme/tree/v9#authentication
--key=<value> (required) ReadMe project API key
DESCRIPTION
Delete a version associated with your ReadMe project.
Expand All @@ -118,12 +108,10 @@ EXAMPLES
$ rdme versions delete <version>
FLAG DESCRIPTIONS
--key=<value>
--key=<value> ReadMe project API key
An API key for your ReadMe project. Note that API authentication is required despite being omitted from the example
usage. See our docs for more information: https://github.com/readmeio/rdme/tree/v9#authentication
ReadMe project API key
```

## `rdme versions update [VERSION]`
Expand All @@ -146,9 +134,7 @@ FLAGS
<options: true|false>
--hidden=<option> Should this version be hidden? The main version cannot be hidden.
<options: true|false>
--key=<value> (required) An API key for your ReadMe project. Note that API authentication is required despite
being omitted from the example usage. See our docs for more information:
https://github.com/readmeio/rdme/tree/v9#authentication
--key=<value> (required) ReadMe project API key
--main=<option> Should this be the main version for your project?
<options: true|false>
--newVersion=<value> What should the version be renamed to?
Expand All @@ -168,10 +154,8 @@ EXAMPLES
--deprecated={true|false} --hidden={true|false}
FLAG DESCRIPTIONS
--key=<value>
--key=<value> ReadMe project API key
An API key for your ReadMe project. Note that API authentication is required despite being omitted from the example
usage. See our docs for more information: https://github.com/readmeio/rdme/tree/v9#authentication
ReadMe project API key
```
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "rdme",
"version": "9.0.2-next.2",
"version": "9.0.2",
"description": "ReadMe's official CLI and GitHub Action.",
"license": "MIT",
"author": "ReadMe <support@readme.io> (https://readme.com)",
Expand Down

0 comments on commit 7afc4d4

Please sign in to comment.