feat: new reference upload command#1261
Merged
Merged
Conversation
emilyskuo
commented
Jun 14, 2025
emilyskuo
commented
Jun 14, 2025
kanadgupta
suggested changes
Jun 17, 2025
kanadgupta
left a comment
kanadgupta
left a comment
Contributor
There was a problem hiding this comment.
this all looks great! the two blocking pieces of feedback should be fairly trivial:
- separating out the type fixes in the
src/lib/types/openapiDoc.tsinto its own PR - renaming the command from
rdme references uploadtordme reference upload. could you also rename the two parent folders from "references" to "reference"?
4 tasks
emilyskuo
changed the title
references upload commandreference upload command
## 🧰 Changes this piggybacks off of @emilyskuo's work in #1261 and implements a suggestion i had in [this comment](https://github.com/readmeio/rdme/pull/1261/files#r2151162521) (i.e., consolidating the tests for guides and reference uploads into a single test suite wrapped in a `describe.each`). for now it consolidates the tests for `rdme docs upload` and `rdme reference upload`, but i figured it'll alleviate some of the burden of shipping support for custom pages, etc. going forward. as part of this, i did the following: - [x] wrapped everything in a `describe.each` - [x] added a bunch of template strings for the routes - [x] duplicated a handful of fixtures - [x] incorporated this feedback: https://github.com/readmeio/rdme/pull/1261/files#r2151151087 ## 🧬 QA & Testing i went through all of the snapshots to make sure it all checks out, but please feel free to look through everything yourself!
kanadgupta
approved these changes
Jun 18, 2025
kanadgupta
left a comment
kanadgupta
left a comment
Contributor
There was a problem hiding this comment.
one tiny copy edit below, otherwise LGTM! great work here ❤️🔥
Co-authored-by: Kanad Gupta <git@kanad.dev>
kanadgupta
pushed a commit
that referenced
this pull request
Jun 18, 2025
# [10.3.0-next.3](v10.3.0-next.2...v10.3.0-next.3) (2025-06-18) ### Features * new `reference upload` command ([#1261](#1261)) ([01e8198](01e8198)) [skip ci]
Contributor
|
🎉 This PR is included in version 10.3.0-next.3 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
kanadgupta
pushed a commit
that referenced
this pull request
Jun 24, 2025
# [10.3.0](v10.2.2...v10.3.0) (2025-06-24) ### Bug Fixes * **lib/fetchSchema:** don't fetch OAS schemas from our API ([#1267](#1267)) ([7344309](7344309)) * **openapi/upload:** handle `pending_update` ([#1269](#1269)) ([9e94ac1](9e94ac1)) ### Features * filter `oas/analyzer` data by allowed keys ([#1259](#1259)) ([766fb42](766fb42)) * new `reference upload` command ([#1261](#1261)) ([01e8198](01e8198)) * properly display file size feature in openapi inspect command ([#1257](#1257)) ([d957cb2](d957cb2)) [skip ci]
Contributor
|
🎉 This PR is included in version 10.3.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
kanadgupta
added
released
command:pages
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
Creating a new
reference uploadcommand for users to upload MD pages to the reference section. This is entirely based on thedocs uploadcommand, with most of it being exactly the same, minus the route and some typing.I had looked into making this an alias of
docs upload, but oclif doesn't tell you how the command was invoked, and we'd have to parseargvs to figure out if docs or reference, which could potentially work but would also be pretty brittle. Otherwise, we could create a general upload command for markdown pages and add a type arg, which would be changing up behavior even more.🧬 QA & Testing
@kanadgupta consolidated our markdown upload command tests in #1262 🎉