chore: setup v1 support mode

Author: tatomyr

.changeset/config.json

@@ -5,7 +5,7 @@
   "fixed": [["@redocly/cli", "@redocly/openapi-core", "@redocly/respect-core"]],
   "linked": [],
   "access": "public",
-  "baseBranch": "main",
+  "baseBranch": "v1",
   "updateInternalDependencies": "patch",
   "ignore": []
 }

.github/workflows/performance.yaml

@@ -3,7 +3,7 @@ name: Performance Benchmark
 on:
   pull_request:
     branches:
-      - main
+      - v1
 
 env:
   CI: true
@@ -21,7 +21,7 @@ jobs:
       - name: Install Dependencies
         run: npm ci
       - name: Install External
-        run: npm i -g hyperfine @redocly/cli@latest
+        run: npm i -g hyperfine @redocly/cli@v1
       - name: Prepare
         run: |
           jq '.bin = {"redocly-next":"bin/cli.js"} | .name = "@redocly/cli-next"' packages/cli/package.json > __tmp__.json
@@ -42,8 +42,8 @@ jobs:
           comment_tag: latest-vs-next-comparison
 
   historical-versions:
-    # Run only on release branch (changeset-release/main):
-    if: github.head_ref == 'changeset-release/main'
+    # Run only on release branch (changeset-release/v1):
+    if: github.head_ref == 'changeset-release/v1'
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

.github/workflows/release.yaml

@@ -3,7 +3,7 @@ name: Release
 on:
   push:
     branches:
-      - main
+      - v1
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -101,7 +101,7 @@ jobs:
             ghcr.io/redocly/cli
           tags: |
             ${{ steps.get_version.outputs.value }}
-            latest
+            v1
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v1
@@ -144,7 +144,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
       - name: Install CLI from npm
-        run: npm i -g @redocly/cli@latest
+        run: npm i -g @redocly/cli@v1
       - name: Test version from NPM
         continue-on-error: true
         run: |
@@ -159,7 +159,7 @@ jobs:
           redocly bundle https://raw.githubusercontent.com/Rebilly/api-definitions/main/openapi/openapi.yaml -o bundled.json
           redocly build-docs https://raw.githubusercontent.com/Rebilly/api-definitions/main/openapi/openapi.yaml
       - name: Pull docker image
-        run: docker pull redocly/cli:latest
+        run: docker pull redocly/cli:v1
       - name: Test docker image
         continue-on-error: true
         run: |

.github/workflows/require-changeset.yaml

@@ -5,7 +5,7 @@ on:
 
 jobs:
   require-changeset-or-label:
-    if: ${{ !contains(github.event.pull_request.labels.*.name, 'no changeset needed') && github.head_ref != 'changeset-release/main' }}
+    if: ${{ !contains(github.event.pull_request.labels.*.name, 'no changeset needed') && github.head_ref != 'changeset-release/v1' }}
     runs-on: ubuntu-latest
     env:
       CI: true
@@ -20,4 +20,4 @@ jobs:
           cache: 'npm'
       - run: npm ci
       - name: Check for changeset
-        run: npx changeset status --since origin/main
+        run: npx changeset status --since origin/v1

.github/workflows/snapshot-pr.yaml

@@ -2,17 +2,16 @@ name: Snapshot Release
 
 on:
   pull_request:
-    types: [closed]
-    branches:
-      - snapshot
+    types: [labeled]
 
 jobs:
   release-snapshot:
-    if: github.event.pull_request.merged == true
+    if: github.event.label.name == 'snapshot'
     runs-on: ubuntu-latest
     permissions:
       contents: write
       pull-requests: write
+
     steps:
       - uses: actions/checkout@v4
 
@@ -41,13 +40,15 @@ jobs:
           jq ".dependencies[\"@redocly/respect-core\"] = \"$VERSION\"" packages/cli/package.json > tmp.json && mv tmp.json packages/cli/package.json
 
           # Add comment with installation instructions
-          COMMENT="📦 A new experimental version **v$VERSION** of Redocly CLI has been published for testing.
+          COMMENT="📦 A new experimental 🧪 version **v$VERSION** of Redocly CLI has been published for testing.
 
           Install with NPM:
           \`\`\`bash
           npm install @redocly/cli@$VERSION
           # or
           npm install @redocly/openapi-core@$VERSION
+          # or
+          npm install @redocly/respect-core@$VERSION
           \`\`\`
 
           ⚠️ Note: This is a development build and may contain unstable features."

.github/workflows/snapshot-release.yaml

@@ -5,7 +5,7 @@ on:
     types: [opened, synchronize, reopened]
   push:
     branches:
-      - main
+      - v1
 
 env:
   CI: true

.github/workflows/tests.yaml

@@ -27,7 +27,7 @@ Before submitting your contribution though, please make sure to take a moment an
 
 Before submitting a pull request, please make sure the following is done:
 
-1. Fork the repository and create your branch from `main`.
+1. Fork the repository and create your branch from `v1`.
 1. Run `npm install` in the repository root.
 1. If you’ve fixed a bug or added code that should be tested, don't forget to add [tests](#tests)!
 1. Ensure the test suite passes (see the [Tests section](#tests) for more details).
@@ -251,22 +251,22 @@ We use [Changesets](https://github.com/changesets/changesets) flow.
 After merging a PR with a changeset, the release PR is automatically created.
 
 If the pipelines are not starting, close and reopen the PR.
-Merging that PR triggers the release process.
+Merging that PR triggers the release process under the `v1` label.
 
 ### Revert a release
 
 There's no possibility to revert a release itself.
 However, you can release a new version with a problematic commit reverted.
-Create a new branch from **main**, then find the hash of the commit you want to revert and run `git revert <commit-hash>`.
+Create a new branch from **v1**, then find the hash of the commit you want to revert and run `git revert <commit-hash>`.
 Create a patch-level changeset for the revert and open a PR with it.
 Merge the PR and cut a release according to the [Release flow](#release-flow).
 
 ### Snapshot release
 
 To release an experimental version to the **NPM** registry, follow these steps:
 
-1. Create a new PR to **main**.
-2. Add the `snapshot` label to the PR. This creates a new PR with to the `snapshot` branch (which is a copy of the `main` branch).
-3. Merging the second PR triggers release to the **NPM** registry under the `snapshot` tag.
+1. Create a new PR to **v1**.
+2. Add the `snapshot` label to the PR.
+   This triggers a release of the current branch changes to the **NPM** registry under the `snapshot` tag.
 
-The released version can be installed with `npm install @redocly/cli@snapshot`.
+The released version can be installed with `npm install @redocly/cli@snapshot`

CONTRIBUTING.md

@@ -16,7 +16,7 @@ Supports OpenAPI 3.1, 3.0 and OpenAPI 2.0 (legacy Swagger), AsyncAPI 3.0 and 2.6
 ### Node
 
 ```sh
-npx @redocly/cli@latest lint path-to-root-file.yaml
+npx @redocly/cli@v1 lint path-to-root-file.yaml
 ```
 
 Alternatively, install it globally with `npm`:

README.md

@@ -1,7 +1,7 @@
 import { join } from 'path';
 import { getParams, getCommandOutput } from '../utils';
 
-test('free apis test case', () => {
+test.skip('free apis test case', () => {
   const indexEntryPoint = join(process.cwd(), 'packages/cli/lib/index.js');
   const fixturesPath = join(__dirname, 'free.arazzo.yaml');
   const args = getParams(indexEntryPoint, ['respect', fixturesPath]);