Merge branch 'v10-release' into kanad-2024-12-05/v10-migration-guide

.github/workflows/ci.yml

@@ -113,3 +113,11 @@ jobs:
         uses: ./rdme-repo/
         with:
           rdme: openapi "oas-examples-repo/3.1/json/petstore.json" --key "${{ secrets.RDME_TEST_PROJECT_API_KEY }}" --id=${{ secrets.RDME_TEST_PROJECT_API_SETTING }}
+
+      # this is a test to ensure that the rdme github action can run properly
+      # the way that our users invoke it
+      - name: E2E run of `openapi validate` on `next` branch
+        uses: readmeio/rdme@next
+        if: ${{ github.ref }} == 'refs/heads/next'
+        with:
+          rdme: openapi validate oas-examples-repo/3.1/json/petstore.json

.github/workflows/docs.yml

@@ -1,7 +1,10 @@
 name: Sync `documentation` directory to ReadMe
 
 # Run workflow for every push
-on: push
+on:
+  push:
+    branches:
+      - main
 
 jobs:
   sync:
@@ -40,33 +43,7 @@ jobs:
           regex: false
           include: documentation/*
 
-      # Since this workflow file is in the `rdme` repository itself,
-      # we need to test the GitHub Action using the current commit.
-      # This step builds the `rdme` action code so we can do that.
-      #
-      # This step is not required for syncing your docs to ReadMe!
-      - name: Rebuild GitHub Action for testing purposes
-        run: npm run build:gha
-
-      # And finally, with our updated documentation,
-      # we run the `rdme` GitHub Action to sync the Markdown file
-      # in the `documentation` directory.
-      # Here's the page we're syncing: https://docs.readme.com/docs/rdme
-
-      # First we're going to perform a dry run of syncing process.
-      # We do this on every push to ensure that an actual sync will work properly
-      - name: Sync docs to ReadMe (dry run)
-        uses: ./
-        with:
-          rdme: docs ./documentation --key=${{ secrets.README_DEVELOPERS_API_KEY }} --version=${{ vars.README_DEVELOPERS_MAIN_VERSION }} --dryRun
-
-      # And finally, we perform an actual sync to ReadMe if we're on the main branch
       - name: Sync docs to ReadMe
-        if: github.event_name == 'push' && github.event.ref == 'refs/heads/main'
-        # We use the `main` branch as ref for GitHub Action
-        # This is NOT recommended, as it can break your workflows without notice!
-        # We recommend specifying a fixed version, i.e. @8.0.0
-        # Docs: https://docs.github.com/actions/using-workflows/workflow-syntax-for-github-actions#example-using-versioned-actions
-        uses: readmeio/rdme@main
+        uses: readmeio/rdme@v9
         with:
           rdme: docs ./documentation --key=${{ secrets.README_DEVELOPERS_API_KEY }} --version=${{ vars.README_DEVELOPERS_MAIN_VERSION }}

CHANGELOG.md

@@ -1,3 +1,39 @@
+## [9.0.4-next.2](https://github.com/readmeio/rdme/compare/v9.0.4-next.1...v9.0.4-next.2) (2024-12-11)
+
+
+### Bug Fixes
+
+* copy package.json file instead of symlinking ([1d56c21](https://github.com/readmeio/rdme/commit/1d56c21b0313fb0dcf0721294196b729eb2eaa49))
+
+## [9.0.4-next.1](https://github.com/readmeio/rdme/compare/v9.0.3...v9.0.4-next.1) (2024-12-11)
+
+
+### Bug Fixes
+
+* bring back [#1117](https://github.com/readmeio/rdme/issues/1117) without breaking everything ([#1120](https://github.com/readmeio/rdme/issues/1120)) ([d5d74c5](https://github.com/readmeio/rdme/commit/d5d74c5ac4200c1e0ceaf994f2ff71086894b2c3))
+
+## [9.0.3](https://github.com/readmeio/rdme/compare/v9.0.2...v9.0.3) (2024-12-11)
+
+
+### Bug Fixes
+
+* revert [#1117](https://github.com/readmeio/rdme/issues/1117) ([#1119](https://github.com/readmeio/rdme/issues/1119)) ([c20cc3c](https://github.com/readmeio/rdme/commit/c20cc3cf89a4e108efa485e46c26e8bfb7ba68d6))
+
+## [9.0.3-next.1](https://github.com/readmeio/rdme/compare/v9.0.2...v9.0.3-next.1) (2024-12-11)
+
+
+### Bug Fixes
+
+* revert [#1117](https://github.com/readmeio/rdme/issues/1117) ([#1119](https://github.com/readmeio/rdme/issues/1119)) ([c20cc3c](https://github.com/readmeio/rdme/commit/c20cc3cf89a4e108efa485e46c26e8bfb7ba68d6))
+
+## [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)
 
 

README.md

@@ -167,16 +167,15 @@ npm run build && npm run build:docs
 # Command Topics
 
 * [`rdme autocomplete`](documentation/commands/autocomplete.md) - Display autocomplete installation instructions.
-* [`rdme categories`](documentation/commands/categories.md) - List or create categories in your ReadMe developer hub.
 * [`rdme changelogs`](documentation/commands/changelogs.md) - Sync Markdown files to your ReadMe project as Changelog posts.
-* [`rdme custompages`](documentation/commands/custompages.md) - Sync Markdown/HTML files to your ReadMe project as Custom Pages.
-* [`rdme docs`](documentation/commands/docs.md) - Sync or prune Guides pages in your ReadMe developer hub.
 * [`rdme help`](documentation/commands/help.md) - Display help for rdme.
 * [`rdme login`](documentation/commands/login.md) - Login to a ReadMe project.
 * [`rdme logout`](documentation/commands/logout.md) - Logs the currently authenticated user out of ReadMe.
 * [`rdme openapi`](documentation/commands/openapi.md) - Manage your API definition (e.g., syncing, validation, analysis, conversion, etc.). Supports OpenAPI, Swagger, and Postman collections, in either JSON or YAML formats.
-* [`rdme versions`](documentation/commands/versions.md) - Manage your documentation versions.
 * [`rdme whoami`](documentation/commands/whoami.md) - Displays the current user and project authenticated with ReadMe.
 
 <!-- commandsstop -->
 <!-- prettier-ignore-end -->
+
+> [!IMPORTANT]
+> You'll notice that several previous `rdme` commands are no longer present. That's because this version is for projects that use [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored) and [bi-directional syncing](https://docs.readme.com/main/docs/bi-directional-sync) is the recommended approach for most workflows previously managed via `rdme`. See more in [our migration guide](./documentation/migration-guide.md).