Commit dae9d6ef authored by Mark Banner's avatar Mark Banner
Browse files

Bug 1498604 - Make './mach doc' use jsdoc installed into node_modules rather... 

Bug 1498604 - Make './mach doc' use jsdoc installed into node_modules rather than the system. r=mossop,ahal

Differential Revision: https://phabricator.services.mozilla.com/D111652
parent c4edcba2

build/sparse-profiles/sphinx-docs

+3 −0
Original line number Diff line number Diff line
@@ -26,6 +26,9 @@ glob:**/*.py 
# moz.build files are read to discover location of docs.

glob:**/moz.build



# package*.json files are needed for node_modules

glob:**/package*.json



# Read to set the version of the docs.

path:config/milestone.txt

package-lock.json

+390 −146

File changed.

Preview size limit exceeded, changes collapsed.

package.json

+1 −0
Original line number Diff line number Diff line
@@ -26,6 +26,7 @@ 
    "eslint-plugin-prettier": "3.3.1",

    "eslint-plugin-react": "7.23.1",

    "eslint-plugin-spidermonkey-js": "file:tools/lint/eslint/eslint-plugin-spidermonkey-js",

    "jsdoc": "3.5.5",

    "prettier": "1.19.1",

    "yarn": "1.22.10"

  },

taskcluster/ci/source-test/doc.yml

+14 −4
Original line number Diff line number Diff line
@@ -19,8 +19,13 @@ generate: 
              name: public/docs.tar.gz

              path: /builds/worker/checkouts/gecko/docs-out/main.tar.gz

    run:

        using: mach

        mach: doc --outdir docs-out --no-open --no-serve --archive

        using: run-task

        cwd: '{checkout}'

        command: >

            cp -r /build/node_modules_eslint node_modules &&

            ln -s ../tools/lint/eslint/eslint-plugin-mozilla node_modules &&

            ln -s ../tools/lint/eslint/eslint-plugin-spidermonkey-js node_modules &&

            ./mach doc --outdir docs-out --no-open --no-serve --archive

        sparse-profile: sphinx-docs

    optimization:

        skip-unless-schedules: [docs]
@@ -45,8 +50,13 @@ upload: 
              name: public/firefox-source-docs-url.txt

              path: /builds/worker/firefox-source-docs-url.txt

    run:

        using: mach

        mach: doc --upload --no-open --no-serve --write-url /builds/worker/firefox-source-docs-url.txt

        using: run-task

        cwd: '{checkout}'

        command: >

            cp -r /build/node_modules_eslint node_modules &&

            ln -s ../tools/lint/eslint/eslint-plugin-mozilla node_modules &&

            ln -s ../tools/lint/eslint/eslint-plugin-spidermonkey-js node_modules &&

            ./mach doc --upload --no-open --no-serve --write-url /builds/worker/firefox-source-docs-url.txt

        sparse-profile: sphinx-docs

    scopes:

        - secrets:get:project/releng/gecko/build/level-{level}/gecko-docs-upload

taskcluster/docker/lint/system-setup.sh

+0 −1
Original line number Diff line number Diff line
@@ -58,7 +58,6 @@ pip3 install -r /build/zstandard_requirements.txt 
# shellcheck disable=SC1091

. install-node.sh



npm install -g jsdoc@3.5.5

npm install -g yarn@1.9.4



/build/tooltool.py fetch -m /tmp/eslint.tt