feat!: v10 release #1113
Merged
feat!: v10 release #1113
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
## 🧰 Changes cleans up a few v9-specific callouts in our main README and main docs page.
This was referenced Dec 10, 2024
## 🧰 Changes Removes the commands that we've deprecated in favor of bidirectional syncing. Will be merging this PR into #1113 to collect all breaking changes as part of this PR! ## 🧬 QA & Testing do tests still pass? ##⚠️ Breaking Changes BREAKING CHANGE: `categories`, `custompages`, `docs` and `versions` have now been removed. Please use a bidirectional syncing workflow instead. Read more in [our migration guide](https://github.com/readmeio/rdme/tree/v10/documentation/migration-guide.md).
## 🧰 Changes Removes the `openapi` command in its current form. Will be replaced by `openapi upload` (see #1116!) Will be merging this PR into #1113 to collect all breaking changes as part of this PR! ## 🧬 QA & Testing Provide as much information as you can on how to test what you've done. ##⚠️ breaking changes BREAKING CHANGE: `rdme openapi` has been removed. Please use `rdme openapi upload` instead. Read more in [our migration guide](https://github.com/readmeio/rdme/tree/v10/documentation/migration-guide.md).
Merged
| 🚥 Resolves RM-11384 | | :------------------- | ## 🧰 Changes `rdme openapi` has now been replaced by `rdme openapi upload` 🚀 highlights: - much simpler flag structure - more intuitive slug-based identifying system, thanks to API v2 - better error messages, thanks to API v2 code review notes - a lot of the diff is related to setting up boilerplate for interacting with API v2 - feedback appreciated on the docs — feel free to review `documentation/commands/openapi.md` or `src/commands/openapi/upload.ts` - feedback appreciated on whether the optional flag should be called `--slug` or `--identifier` or something else. went with `--slug` since it's short and it was easy to write clear explainer docs around <details> <summary>outstanding tasks (archived)</summary> - [x] command - [x] tests - [x] ~~optional `--action` arg?~~ **edit**: might be a good enhancement further down the line, but going to pass on this for now! - [x] tests for `useSpecVersion` - [x] test for `pending` timeout (there's a nock API for duplicating an interceptor, use that!) - [x] finalize command docs - [x] set up [test project](https://rdme-refactored-test.readme.io) for syncing in CI (i.e., adding back what i removed in d69d1aa) </details> <details> <summary>follow-up enhancements</summary> - tests for `readmeAPIv2Fetch` - optional `--action` arg for use in CI to prevent accidental overwrites - optional `--timeout` arg to allow user to configure timeout - GHA onboarding support </details> ## 🧬 QA & Testing this can only be tested locally for now: 1. in your local dev server, load up a project that uses readme refactored 2. set up an API key for said project 3. change the value on [this line](https://github.com/readmeio/rdme/blob/af0e0dca7f715847bd5359d5bf60e1df63a81246/src/lib/config.ts#L4) to be `http://api.readme.local:3000/v2` 4. check out this branch and run the following: ```sh # setup npm ci && npm run build # try running any or all of the following: bin/dev.js openapi upload # try logging in bin/dev.js openapi upload --key <key> # try selecting a file bin/dev.js openapi upload --key <key> __tests__/__fixtures__/petstore-simple-weird-version.json # without a version arg bin/dev.js openapi upload --key <key> __tests__/__fixtures__/petstore-simple-weird-version.json --version=1.0 # with a version arg bin/dev.js openapi upload --key <key> __tests__/__fixtures__/petstore-simple-weird-version.json --useSpecVersion # use the version defined in the spec ``` --------- Co-authored-by: Jon Ursenbach <[email protected]>
kanadgupta
pushed a commit
that referenced
this pull request
Dec 12, 2024
# [10.0.0-next.1](v9.0.5...v10.0.0-next.1) (2024-12-12) * feat!: v10 release ([#1113](#1113)) ([f260a00](f260a00)) ### BREAKING CHANGES * `categories`, `custompages`, `docs` and `versions` have now been removed. Please use a bidirectional syncing workflow instead. Read more in [our migration guide](https://github.com/readmeio/rdme/tree/v10/documentation/migration-guide.md). * `rdme openapi` has been replaced by `rdme openapi upload`. Read more in [our migration guide](https://github.com/readmeio/rdme/tree/v10/documentation/migration-guide.md). [skip ci]
|
🎉 This PR is included in version 10.0.0-next.1 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
kanadgupta
pushed a commit
that referenced
this pull request
Dec 13, 2024
# [10.0.0](v9.0.5...v10.0.0) (2024-12-13) * feat!: v10 release ([#1113](#1113)) ([f260a00](f260a00)) ### BREAKING CHANGES * `categories`, `custompages`, `docs` and `versions` have now been removed. Please use a bidirectional syncing workflow instead. Read more in [our migration guide](https://github.com/readmeio/rdme/tree/v10/documentation/migration-guide.md). * `rdme openapi` has been replaced by `rdme openapi upload`. Read more in [our migration guide](https://github.com/readmeio/rdme/tree/v10/documentation/migration-guide.md). [skip ci]
|
🎉 This PR is included in version 10.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
kanadgupta
added a commit
that referenced
this pull request
Dec 13, 2024
## 🧰 Changes doc updates that we should push to the `v9` channel right before we release `v10`! see #1113 for the sequencing of all of this.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🧰 Changes
this PR aggregates all of the PRs going out as part of the v10 release (i.e, the second section of PRs below). all PRs should be reviewed prior to being merged into this branch.
outstanding tasks
needs to go out before v10 is released (i.e., in the v9 release channel)
needs to go out as part of v10 release
openapi uploadopenapiv1 command #1111openapi upload#1116merge into
v9branch oncev10release is successfully releaseddouble-check these things before merging
v9docs (e.g.,/tree/v9) withv10as needed (b19416d)v10will workopenapi uploadlisting all of the breaking changes 1 by 1 below so they get picked up by semantic release...
BREAKING CHANGE:
categories,custompages,docsandversionshave now been removed. Please use a bidirectional syncing workflow instead. Read more in our migration guide.BREAKING CHANGE:
rdme openapihas been replaced byrdme openapi upload. Read more in our migration guide.