feat!: deprecation notices for non-readme-refactored commands (#1099) (732e32b)
feat!: drop node 18 (#1085) (ebc2ac0)
feat!: final v9 touchups (#1106) (15447c5), closes #1107
feat!: oclif (take 2) (#1068) (5e05f93), closes #962 #1067 /github.com/readmeio/rdme/blob/d01d76fe3c2e4a98b4f5c415be03e589fbe3b56e/.releaserc.yml#L30 #1067
feat!: remove validate, deprecate/hide open (#1072) (f1b46f6)
feat!: switch topic separator to space (#1100) (13eb8ab)

Bug Fixes

add better debugging for fetch failures (a17f8da)
add GITHUB_TOKEN (e106e10)
attempt to use semantic-release/github instead of gh (331d28b)
build dist-gha/ files with every release (f42392b)
bump semantic-release versions (21efc66)
debug properly (#1078) (5de0a4f)
deps: bump more deps (#1042) (786a000)
empty commit to trigger build (51c1566)
empty commit to trigger build (76efb7e)
empty commit to trigger release (3604f2a)
fixed debug script (#908) (82c3541)
hide ExperimentalWarning (#901) (f9b5679)
npm: tweak npm lifecycle scripts (#1073) (35534db)
oclif-friendly error logging (#1080) (73c5f4c)
openapi: add spinner catch statement (#961) (4669b29)
release: track dist-gha assets properly (b0934cb)
release: track changes to commands doc directory (78b6554)
swap out ts-node for tsx (16f64b3)
Update LICENSE for 2024 (#963) (23cf44b)
use newest import attributes syntax (#993) (d76c0ae), closes /github.com/nodejs/node/blob/main/doc/changelogs/CHANGELOG_V20.md#2023-11-22-version-20100
versions/update: various edge cases (#965) (580e307)

chore

type fixes for tests (#903) (d423b4c)

Code Refactoring

remove oas, swagger, docs:edit (#902) (9107d15)

Features

add @oclif/plugin-not-found, other cleanups (#1074) (6529b03)
add title flag to openapi:convert (#1071) (1d71f3f), closes #1068
convert to ESM (breaking change) (#856) (84b8571), closes /www.stefanjudis.com/snippets/how-to-import-json-files-in-es-modules-node-js/#option-1 1#L228
fetch: use undici + ProxyAgent (#1000) (9da7132), closes #999
openapi/convert: support openapi in convert command (#941) (a33bbeb)
revamped oclif-powered docs (#1081) (8a2833b)
sort when syncing by parent (#973) (9795840)
support README_API_KEY env var (#950) (bcf3f18)
support node 18 and up (#900) (a217904)
test: moving unit tests over to vitest (#857) (36d561b), closes #870
use actions/checkout@v4 everywhere (#895) (d30b71c)
versions: flag parity with API, copy fixes (#906) (d424d9f)

BREAKING CHANGES

rdme openapi is deprecated and will be replaced in rdme@10 by a command with a simpler flag setup based on community feedback.
deprecates commands that are not supported in ReadMe Refactored. For more information, please visit our migration guide: https://github.com/readmeio/rdme/tree/v9/documentation/migration-guide.md

🧬 QA & Testing

Does the copy in these deprecation warnings make sense to you? Note that the links will be broken for now since we haven't tagged a proper v9 release yet, but that will be fixed once this release is out!

the topic separator (i.e., what separates a command from its subcommand) has changed from a colon to a space by default. For example, rdme openapi:validate is now rdme openapi validate. The colon topic separator will continue to be supported so there is no need to change any existing commands, but all documentation and help screens will reflect the space topic separator.

🧬 QA & Testing

Do tests still pass?

dropping support for Node.js v18. The minimum required Node.js version is v20.10.0.
rdme validate has been removed, use rdme openapi:validate instead.
rdme open is now deprecated

also updates our docs accordingly

the rdme GitHub Actions is now a the node20 JavaScript action rather than a Docker container action.
rdme is now powered by oclif. The formatting and content of certain error messages and outputs may have changed. Please continue to only utilize exit codes to determine command successes/failures.

completed tasks:

[x] a handful of tests are still failing, hoping that https://github.com/oclif/test/pull/652 gets merged in)
[x] github actions dry runs are failing (but i got them working in

versions: this flips the isPublic flag to hidden.
removes several deprecated commands
chore: knip cleanup
chore: type fixes for tests
removes several deprecated commands
Node.js >= 18 required

9.0.0-next.36

Diff

kanadgupta

published 9.0.0-next.36 • 2 months ago

Changelog

Source

9.0.0-next.36 (2024-12-06)

feat!: final v9 touchups (#1106) (15447c5), closes #1107

BREAKING CHANGES

rdme openapi is deprecated and will be replaced in rdme@10 by a command with a simpler flag setup based on community feedback.

…