Npm install support - Githubissues

We were sort of discussing this recently. Right now, our default commands executed for builds are meant to serve Python based projects. This comes from all of the tooling we directly supported historically being Python based tools -- Sphinx and Mkdocs.

More direct support for Node/etc tooling is getting into some new area for us, so we don't yet have concrete plans here. Feedback here is definitely helpful for us!

So, a few things that we've discussed at some points:

We've talked about at very least offering overrides to default build jobs. These are discussed more here:

Extending the build process

The missing jobs right now are:

build.jobs.install - Override all of our install commands
build.jobs.build.html - Override all of our (HTML) build commands

You can sort of accomplish this now with the pre_install/post_install jobs too. But official support might look like:

build:
  jobs:
    install:
      - npm install
    build:
      html:
        - npm run build
        - ...

As far as native support for npm install in our configuration file, these additions are hard for us to maintain. So, we might instead prefer to keep npm/etc support at simply overriding build.jobs.install for now. This feels reasonable as there probably isn't much to gain from our configuration file acting as a proxy.

You can also do this with build.commands but need to control the build process entirely.

Our eventual goal here is to support/offer reusable, community build packages, where users only need to specify the tooling package and it's arguments. This is a far ways out though.

As far as caching goes, we do not cache anything between builds anyways. Each build requires a full, fresh checkout of your repository. We've tried caching layers and surprisingly saw little improvement with build time.

readthedocs / readthedocs.org

Npm install support #11216

What's the problem this feature will solve?

Describe the solution you'd like

Alternative solutions