Skip to content

Commit da158bf

Browse files
kanadguptaerunionsemantic-release-botdependabot[bot]
authored
chore: backport v9 changes back to v10 (#1147)
## 🧰 Changes takes the following changes from `v9` and reapplies them into `next` so the branches are in sync: - [x] #1145 - [x] 1cb1c4d - [x] 44779e2 very curious if there's a better way to do this lol ## 🧬 QA & Testing do tests pass? --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Jon Ursenbach <erunion@users.noreply.github.com> Co-authored-by: semantic-release-bot <semantic-release-bot@martynus.net> Co-authored-by: Jon Ursenbach <jon@ursenba.ch> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
1 parent 1e19906 commit da158bf

File tree

4 files changed

+11
-4
lines changed

4 files changed

+11
-4
lines changed

.releaserc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ branches:
44
- name: next
55
prerelease: true
66
- name: v9
7-
channel: 9.x
7+
range: 9.x
88

99
plugins:
1010
- '@semantic-release/commit-analyzer'

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@
55

66
* **openapi:** type fixes in `prepareOas` ([#1141](https://github.com/readmeio/rdme/issues/1141)) ([fc55d28](https://github.com/readmeio/rdme/commit/fc55d285658e7918bc697398d7c2b10e8a39cacc))
77

8+
# [9.1.0](https://github.com/readmeio/rdme/compare/v9.0.5...v9.1.0) (2025-01-06)
9+
10+
11+
### Features
12+
13+
* **v9:** backport openapi tooling etc. from v10 ([#1145](https://github.com/readmeio/rdme/issues/1145)) ([14828db](https://github.com/readmeio/rdme/commit/14828db4aa8d29c2509198ed2be53b91e9ce3fdb))
14+
815
# [10.1.0-next.2](https://github.com/readmeio/rdme/compare/v10.1.0-next.1...v10.1.0-next.2) (2025-01-06)
916

1017

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,13 +101,13 @@ When writing command logic, avoid using `console` statements (and correspondingl
101101

102102
<summary><b>Updated Guidance</b></summary>
103103

104-
When writing command logic, avoid using `console` statements. As modeled by [the `openapi upload` command](./src/commands/openapi/upload.ts), we use [`oclif`'s command methods](https://oclif.io/docs/commands/#command-methods) for writing to the console. This allows us to seamlessly integrate [`oclif`'s support for JSON output](https://oclif.io/docs/json/).
104+
When writing command logic, avoid using `console` statements. As modeled by [the `openapi upload` command](https://github.com/readmeio/rdme/blob/1e199064b0418b11b56ce08bad3d96ff2bead10c/src/commands/openapi/upload.ts) (only available in `v10` and above), we use [`oclif`'s command methods](https://oclif.io/docs/commands/#command-methods) for writing to the console. This allows us to seamlessly integrate [`oclif`'s support for JSON output](https://oclif.io/docs/json/).
105105

106106
[The `@oclif/test` helper](https://github.com/oclif/test) automatically mocks any writes to `stdout` or `stderr`. This is great for properly asserting `rdme` outputs, but can be a bit confusing to develop with at first if you rely on `console.log` as part of your debugging since those statements won't get written to the console the way you'd expect.
107107

108108
If you rely on `console.log` (or something similar) during development, you can do the following to view your output:
109109

110-
1. Make sure you're using the `runCommand` helper in [this file](./__tests__/helpers/oclif.ts) and **not** `runCommandAndReturnResult`. See [this test file](./__tests__/commands/openapi/upload.test.ts) for an example.
110+
1. Make sure you're using the `runCommand` helper in [this file](https://github.com/readmeio/rdme/blob/1e199064b0418b11b56ce08bad3d96ff2bead10c/__tests__/helpers/oclif.ts) and **not** `runCommandAndReturnResult`. See [this test file](https://github.com/readmeio/rdme/blob/1e199064b0418b11b56ce08bad3d96ff2bead10c/__tests__/commands/openapi/upload.test.ts) for an example.
111111

112112
2. Add a statement like this in your test:
113113

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ To set this up, check out [1Password's documentation on the ReadMe shell plugin]
137137

138138
```sh
139139
export HTTPS_PROXY=https://proxy.example.com:5678
140-
rdme openapi upload
140+
rdme login
141141
```
142142

143143
# GitHub Actions Configuration

0 commit comments

Comments
 (0)