Merge branch 'v9' into oleh/openapi-adding-command-to-solve-circulari…

…ty-and-recursiveness

.github/workflows/ci.yml

@@ -5,6 +5,7 @@ on:
     branches:
       - main
       - next
+      - v9
   pull_request:
 
 jobs:

.github/workflows/codeql-analysis.yml

@@ -2,9 +2,9 @@ name: 'CodeQL'
 
 on:
   push:
-    branches: [main, next]
+    branches: [main, next, v9]
   pull_request:
-    branches: [main, next]
+    branches: [main, next, v9]
   schedule:
     - cron: '0 12 * * 1'
 

.github/workflows/release.yml

@@ -4,6 +4,7 @@ on:
     branches:
       - main
       - next
+      - v9
 
 env:
   REGISTRY: ghcr.io
@@ -42,12 +43,14 @@ jobs:
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
         run: npx semantic-release
 
-      - name: Sync changes back to next
-        if: ${{ github.ref }} == 'refs/heads/main'
-        uses: ad-m/github-push-action@master
-        with:
-          github_token: ${{ secrets.RELEASE_GH_TOKEN }}
-          branch: next
+      ## the v9 branch is not syncing changes back to next so we can skip this step
+      ## as for why this step keeps getting hit despite the if-statement, no idea
+      # - name: Sync changes back to next
+      #   if: ${{ github.ref }} == 'refs/heads/main'
+      #   uses: ad-m/github-push-action@master
+      #   with:
+      #     github_token: ${{ secrets.RELEASE_GH_TOKEN }}
+      #     branch: next
 
   # quick assertion to validate that rdme CLI can be installed and run on ubuntu
   postrelease:

.releaserc.yml

@@ -3,6 +3,8 @@ branches:
   - name: main
   - name: next
     prerelease: true
+  - name: v9
+    channel: 9.x
 
 plugins:
   - '@semantic-release/commit-analyzer'

CHANGELOG.md

@@ -1,3 +1,34 @@
+## [9.0.5](https://github.com/readmeio/rdme/compare/v9.0.4...v9.0.5) (2024-12-12)
+
+
+### Bug Fixes
+
+* do not force push a tag called v9 ([df27049](https://github.com/readmeio/rdme/commit/df27049657ac0c55b019cac54a6d45195c330a6b))
+
+## [9.0.5-next.1](https://github.com/readmeio/rdme/compare/v9.0.4...v9.0.5-next.1) (2024-12-12)
+
+
+### Bug Fixes
+
+* do not force push a tag called v9 ([df27049](https://github.com/readmeio/rdme/commit/df27049657ac0c55b019cac54a6d45195c330a6b))
+
+## [9.0.4](https://github.com/readmeio/rdme/compare/v9.0.3...v9.0.4) (2024-12-12)
+
+
+### 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))
+* **ci:** semantic-release workflow for v9 releases ([#1082](https://github.com/readmeio/rdme/issues/1082)) ([410daa7](https://github.com/readmeio/rdme/commit/410daa79655feb66ebb0afcafeefaa89e1f7dfe4))
+* copy package.json file instead of symlinking ([1d56c21](https://github.com/readmeio/rdme/commit/1d56c21b0313fb0dcf0721294196b729eb2eaa49))
+* openapi arg doc enhancements, refactors ([#1122](https://github.com/readmeio/rdme/issues/1122)) ([b83b233](https://github.com/readmeio/rdme/commit/b83b23337c09f053bf470bf4b41615353b1f3eae))
+
+## [9.0.4-next.4](https://github.com/readmeio/rdme/compare/v9.0.4-next.3...v9.0.4-next.4) (2024-12-12)
+
+
+### Bug Fixes
+
+* **ci:** semantic-release workflow for v9 releases ([#1082](https://github.com/readmeio/rdme/issues/1082)) ([410daa7](https://github.com/readmeio/rdme/commit/410daa79655feb66ebb0afcafeefaa89e1f7dfe4))
+
 ## [9.0.4-next.3](https://github.com/readmeio/rdme/compare/v9.0.4-next.2...v9.0.4-next.3) (2024-12-12)
 
 

README.md

@@ -20,7 +20,7 @@ With `rdme`, you can manage your API definition (we support [OpenAPI](https://sp
 Not using ReadMe for your docs? No worries. `rdme` has a variety of tools to help you identify issues with your API definition — no ReadMe account required.
 
 > [!WARNING]
-> Heads up: our [new ReadMe Refactored experience](https://docs.readme.com/main/docs/welcome-to-readme-refactored) doesn’t yet support `rdme`. If your project is using the new ReadMe Refactored experience, we recommend [enabling bi-directional syncing via Git](https://docs.readme.com/main/docs/bi-directional-sync) for an even better editing experience for the technical and non-technical users on your team!
+> If you're using the [new ReadMe Refactored experience](https://docs.readme.com/main/docs/welcome-to-readme-refactored), you'll want to use `rdme@10` instead. Head over to [our migration guide](https://github.com/readmeio/rdme/blob/next/documentation/migration-guide.md) for more information.
 
 # Table of Contents
 

bin/set-major-version-tag.js

@@ -58,6 +58,13 @@ async function setMajorVersionTag() {
 
     const majorTag = `v${parsedVersion.major}`;
 
+    // we maintain a v9 branch, this just ensures that we don't attempt to also push a tag with the same ref
+    if (majorTag === 'v9') {
+      // eslint-disable-next-line no-console
+      console.warn('A `v9` ref already exists, not setting major version tag');
+      return;
+    }
+
     await runGitCmd(['tag', majorTag, '--force', '--message', `Top-level tag pointing to ${parsedVersion.version}`]);
 
     const args = process.argv.slice(2);

documentation/migration-guide.md

@@ -28,10 +28,8 @@ npx markdown-toc documentation/migration-guide.md --maxdepth 2 --bullets="-" -i
 ## Migrating to `rdme@10`
 
 <!-- prettier-ignore-start -->
-> [!WARNING]
-> `rdme@10` has not been released yet, so this section is still under construction.
->
-> [Please verify that you're looking at the latest docs for v9](https://github.com/readmeio/rdme/tree/v9/documentation/migration-guide.md). If you're using ReadMe Refactored, stay tuned!
+> [!NOTE]
+> If you're using ReadMe Refactored, you'll want to use `rdme@10` or later. The `v10` migration guide can be found [here](https://github.com/readmeio/rdme/tree/v10/documentation/migration-guide.md).
 <!-- prettier-ignore-end -->
 
 ## Migrating to `rdme@9`

package.json

@@ -1,6 +1,6 @@
 {
   "name": "rdme",
-  "version": "9.0.4-next.3",
+  "version": "9.0.5",
   "description": "ReadMe's official CLI and GitHub Action.",
   "license": "MIT",
   "author": "ReadMe <[email protected]> (https://readme.com)",