From efab0336f109a137243cea67a70dcfad70a5e9ec Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Fri, 22 Nov 2024 02:12:15 +0100 Subject: [PATCH] Remove built assets up to date check (#443) We are doing this during the release. --- .circleci/config.yml | 9 --------- .pre-commit-config.yaml | 9 --------- docs/testing.rst | 21 ++------------------- 3 files changed, 2 insertions(+), 37 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 771cef30..06f29869 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -24,15 +24,6 @@ commands: - checkout - run: npm ci - run: npm run build - - run: - name: Ensure built assets are up to date - command: | - if [[ `git status dist/ --porcelain` ]] - then - echo "ERROR: assets are out of date. Make sure to run 'npm run build' on your branch." - git status dist/ --porcelain - exit 1 - fi jobs: checks: diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 03778126..57af03be 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -21,12 +21,3 @@ repos: - id: destroyed-symlinks - id: end-of-file-fixer exclude: "^(dist/|public/|tests/__snapshots__/).*$" - - repo: local - hooks: - - id: check-build-assets - name: Ensure assets are current - description: Ensure that `npm run build` was run before commiting. - language: script - types_or: [css, javascript, svg, json] - pass_filenames: false - entry: .pre-commit/check-build-assets.sh diff --git a/docs/testing.rst b/docs/testing.rst index 6e9249fc..dfee3142 100644 --- a/docs/testing.rst +++ b/docs/testing.rst @@ -22,28 +22,11 @@ localhost Read the Docs ------------- -#. Run development server, ``npm run dev``. +#. Clone addons repository next to your ``readthedocs.org`` code. #. Spin up Docker by running ``inv docker.up``. #. Optional. Define ``USE_PROMOS=True`` if you wan to test EthicalAds addon. -#. Edit ``common/dockerfiles/force-readthedocs-addons.js`` to point to the development server: - - .. code-block:: diff - - - diff --git a/dockerfiles/force-readthedocs-addons.js b/dockerfiles/force-readthedocs-addons.js - index 82a44c4..2b0d46d 100644 - --- a/dockerfiles/force-readthedocs-addons.js - +++ b/dockerfiles/force-readthedocs-addons.js - @@ -15,7 +15,7 @@ - - // add "readthedocs-addons.js" inside the "" - const addonsJs = - - ''; - + ''; - - // selectors we want to remove - // https://developers.cloudflare.com/workers/runtime-apis/html-rewriter/#selectors #. Open any built documentation you already have in your local development instance. +#. Edit any file from addons to see the changes immediately. .. tip::