diff --git a/.github/workflows/e2e-tests.yml b/.github/workflows/e2e-tests.yml index 514a3193..40a678fc 100644 --- a/.github/workflows/e2e-tests.yml +++ b/.github/workflows/e2e-tests.yml @@ -6,7 +6,7 @@ jobs: build-and-e2e: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - - run: npm ci - - run: npm run bundle - - run: npm run e2e + - uses: actions/checkout@v3 + - run: npm ci + - run: npm run bundle + - run: npm run e2e diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index ab74307f..71fa9366 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -11,7 +11,7 @@ jobs: contents: read steps: - name: Check out the repo - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Login to GitHub Container Registry uses: docker/login-action@v1 with: @@ -48,7 +48,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Docker meta id: docker_meta diff --git a/.github/workflows/publish-cli.yml b/.github/workflows/publish-cli.yml index 635eae5e..7827253d 100644 --- a/.github/workflows/publish-cli.yml +++ b/.github/workflows/publish-cli.yml @@ -11,10 +11,10 @@ jobs: if: needs.check-version-cli.outputs.changed == 'true' runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - - uses: actions/setup-node@v2 + - uses: actions/checkout@v3 + - uses: actions/setup-node@v3 - name: Cache node modules - uses: actions/cache@v2 + uses: actions/cache@v3 with: path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS key: npm-${{ hashFiles('package-lock.json') }} @@ -24,7 +24,7 @@ jobs: - run: npm ci - run: npm run bundle - name: Store bundle artifact - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: bundles-cli path: bundles @@ -34,17 +34,17 @@ jobs: if: needs.check-version-cli.outputs.changed == 'true' runs-on: ubuntu-latest steps: - - uses: actions/checkout@v1 + - uses: actions/checkout@v3 - run: npm ci && npm ci --prefix cli - run: npm test e2e-tests: needs: [bundle] runs-on: ubuntu-latest steps: - - uses: actions/checkout@v1 + - uses: actions/checkout@v3 - run: npm ci - name: Download bundled artifact - uses: actions/download-artifact@v2 + uses: actions/download-artifact@v3 with: name: bundles-cli path: bundles @@ -54,10 +54,10 @@ jobs: if: needs.check-version-cli.outputs.changed == 'true' runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - - uses: actions/setup-node@v2 + - uses: actions/checkout@v3 + - uses: actions/setup-node@v3 - name: Cache node modules - uses: actions/cache@v2 + uses: actions/cache@v3 with: path: ~/.npm key: npm-${{ hashFiles('package-lock.json') }} @@ -69,7 +69,7 @@ jobs: - name: Bundle run: npm run compile:cli - name: Store bundle artifact - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: cli path: cli @@ -81,9 +81,9 @@ jobs: changed: ${{ steps.check.outputs.changed }} steps: - name: Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Set up Node.js - uses: actions/setup-node@v2 + uses: actions/setup-node@v3 - name: Check if version has been updated id: check uses: EndBug/version-check@v2.0.1 @@ -96,18 +96,18 @@ jobs: if: needs.check-version-cli.outputs.changed == 'true' runs-on: ubuntu-latest steps: - - uses: actions/setup-node@v1 + - uses: actions/setup-node@v3 with: node-version: '14.x' registry-url: 'https://registry.npmjs.org' - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Download cli bundled artifact - uses: actions/download-artifact@v2 + uses: actions/download-artifact@v3 with: name: cli path: cli - name: Cache node modules - uses: actions/cache@v2 + uses: actions/cache@v3 with: path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS key: npm-${{ hashFiles('package-lock.json') }} diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 5146cb04..34ee6557 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -9,10 +9,10 @@ jobs: bundle: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - - uses: actions/setup-node@v2 + - uses: actions/checkout@v3 + - uses: actions/setup-node@v3 - name: Cache node modules - uses: actions/cache@v2 + uses: actions/cache@v3 with: path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS key: npm-${{ hashFiles('package-lock.json') }} @@ -22,7 +22,7 @@ jobs: - run: npm ci - run: npm run bundle - name: Store bundle artifact - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: bundles path: bundles @@ -30,17 +30,17 @@ jobs: unit-tests: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v1 + - uses: actions/checkout@v3 - run: npm ci && npm ci --prefix cli - run: npm test e2e-tests: needs: [bundle] runs-on: ubuntu-latest steps: - - uses: actions/checkout@v1 + - uses: actions/checkout@v3 - run: npm ci - name: Download bundled artifact - uses: actions/download-artifact@v2 + uses: actions/download-artifact@v3 with: name: bundles path: bundles @@ -50,7 +50,7 @@ jobs: # needs: [bundle, unit-tests, e2e-tests] # runs-on: ubuntu-latest # steps: - # - uses: actions/checkout@v1 + # - uses: actions/checkout@v3 # - name: Configure AWS Credentials # uses: aws-actions/configure-aws-credentials@v1 # with: @@ -60,7 +60,7 @@ jobs: # - name: Install dependencies # run: npm ci # - name: Download bundled artifacts - # uses: actions/download-artifact@v2 + # uses: actions/download-artifact@v3 # with: # name: bundles # path: bundles @@ -71,21 +71,22 @@ jobs: # - name: Invalidate # run: aws cloudfront create-invalidation --distribution-id ${{ secrets.CF_DEMO_DISTRIBUTION_ID }} --paths "/*" publish: + name: Publish to NPM needs: [bundle, unit-tests, e2e-tests] runs-on: ubuntu-latest steps: - - uses: actions/setup-node@v1 + - uses: actions/setup-node@v3 with: node-version: '14.x' registry-url: 'https://registry.npmjs.org' - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Download bundled artifacts - uses: actions/download-artifact@v2 + uses: actions/download-artifact@v3 with: name: bundles path: bundles - name: Cache node modules - uses: actions/cache@v2 + uses: actions/cache@v3 with: path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS key: npm-${{ hashFiles('package-lock.json') }} @@ -98,3 +99,21 @@ jobs: run: npm publish env: NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} + + publish-cdn: + name: Publish to CDN + needs: [bundle, unit-tests, e2e-tests] + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v3 + - name: Configure AWS + uses: aws-actions/configure-aws-credentials@v1 + with: + aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} + aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} + aws-region: us-east-1 + - name: Download all artifact + uses: actions/download-artifact@v3 + - name: Publish to S3 + run: npm run publish-cdn diff --git a/.github/workflows/sync.yml b/.github/workflows/sync.yml index ba673bd0..f8fdde7f 100644 --- a/.github/workflows/sync.yml +++ b/.github/workflows/sync.yml @@ -9,10 +9,10 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout Repository - uses: actions/checkout@master + uses: actions/checkout@v3 - name: Run GitHub File Sync uses: Redocly/repo-file-sync-action@master with: GH_PAT: ${{ secrets.GH_PAT }} - COMMIT_PREFIX: "sync:" + COMMIT_PREFIX: 'sync:' SKIP_PR: true diff --git a/.github/workflows/unit-tests.yml b/.github/workflows/unit-tests.yml index 3df1b925..ed1d672b 100644 --- a/.github/workflows/unit-tests.yml +++ b/.github/workflows/unit-tests.yml @@ -6,7 +6,7 @@ jobs: build-and-unit: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v1 + - uses: actions/checkout@v3 - run: npm ci && npm ci --prefix cli - run: npm run bundle - run: npm test diff --git a/CHANGELOG.md b/CHANGELOG.md index c4825105..56cb1429 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,33 @@ +# [2.0.0-rc.71](https://github.com/Redocly/redoc/compare/v2.0.0-rc.70...v2.0.0-rc.71) (2022-05-31) + + +### Bug Fixes + +* constraints label details ([eb0917d](https://github.com/Redocly/redoc/commit/eb0917d002e57353027fee9c8f07605de8f1ff6f)) +* merge allOf in correct order ([#2020](https://github.com/Redocly/redoc/issues/2020)) ([1e4ea03](https://github.com/Redocly/redoc/commit/1e4ea03d4a9b7eddf3e4cc7cbdbd4d913583e837)) + + +### Features + +* add hideSecuritySection option allowing to disable the Security panel ([#2027](https://github.com/Redocly/redoc/issues/2027)) ([49cc11d](https://github.com/Redocly/redoc/commit/49cc11d91795653ca870e9276a1e0cd617964e25)) +* add Redoc to Redocly CDN ([#2026](https://github.com/Redocly/redoc/issues/2026)) ([77104d6](https://github.com/Redocly/redoc/commit/77104d6c0d6f457aa08a158e93b52a45877be84e)) +* add support prefix items ([27a9dba](https://github.com/Redocly/redoc/commit/27a9dbaf46aded01a6512645dab27870a85cc73b)) +* remove auth section ([#2022](https://github.com/Redocly/redoc/issues/2022)) ([a863302](https://github.com/Redocly/redoc/commit/a863302cc803bdf27187c613157ba90af1040fc4)) +* show minProperties maxProperties ([#2015](https://github.com/Redocly/redoc/issues/2015)) ([82712c5](https://github.com/Redocly/redoc/commit/82712c5b408dc6bc142307d45fb962de2a43ffba)) + + + +# [2.0.0-rc.70](https://github.com/Redocly/redoc/compare/2.0.0-rc.69...2.0.0-rc.70) (2022-05-17) + + +### Features + +* display patternProperties ([#2008](https://github.com/Redocly/redoc/issues/2008)) ([660cc85](https://github.com/Redocly/redoc/commit/660cc857bc86787e16237b407fe5f5d7a493bb48)) +* support conditional operators ([#1939](https://github.com/Redocly/redoc/issues/1939)) ([291b62a](https://github.com/Redocly/redoc/commit/291b62a206b68f8b4d98e4b74b71c0cad20a8b9b)) +* theme add links textDecoration options ([#1599](https://github.com/Redocly/redoc/issues/1599)) ([ba06485](https://github.com/Redocly/redoc/commit/ba06485ece27acbb6b846500817f4bff3e4997ba)) + + + # [2.0.0-rc.69](https://github.com/Redocly/redoc/compare/v2.0.0-rc.68.1...v2.0.0-rc.69) (2022-05-12) diff --git a/README.md b/README.md index ddc7411d..5040347a 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [](https://travis-ci.com/Redocly/redoc) [](https://coveralls.io/github/Redocly/redoc?branch=master) [](https://www.npmjs.com/package/redoc) [](https://github.com/Redocly/redoc/blob/master/LICENSE) - [](https://cdn.jsdelivr.net/npm/redoc/bundles/redoc.standalone.js) [](https://www.npmjs.com/package/redoc) [](https://www.jsdelivr.com/package/npm/redoc) [](https://hub.docker.com/r/redocly/redoc/) + [](https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js) [](https://www.npmjs.com/package/redoc) [](https://www.jsdelivr.com/package/npm/redoc) [](https://hub.docker.com/r/redocly/redoc/) **This is the README for the `2.x` version of Redoc (React-based).** @@ -102,9 +102,9 @@ Refer to the Redocly's documentation for more information on these products:  ## Releases -**Important:** all the 2.x releases are deployed to npm and can be used with jsdeliver: -- particular release, for example, `v2.0.0-alpha.15`: https://cdn.jsdelivr.net/npm/redoc@2.0.0-alpha.17/bundles/redoc.standalone.js -- `next` release: https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js +**Important:** all the 2.x releases are deployed to npm and can be used with Redocly-cdn: +- particular release, for example, `v2.0.0-rc.70`: https://cdn.redoc.ly/redoc/v2.0.0-rc.70/bundles/redoc.standalone.js +- `latest` release: https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js Additionally, all the 1.x releases are hosted on our GitHub Pages-based CDN **(deprecated)**: - particular release, for example `v1.2.0`: https://rebilly.github.io/ReDoc/releases/v1.2.0/redoc.min.js @@ -166,7 +166,7 @@ replace the `spec-url` attribute with the url or local file address to your defi