[email protected] -- Doesn't build on CI

[adierkens]

Bug Report

Describe the bug

If you run docz build on a fresh project (one that doesn't have the .docz folder created), it fails:

npm run docz:build

> @proof/[email protected] docz:build /Users/adierkens/Developer/proof/packages/docs
> docz build

cd: no such file or directory: /Users/adierkens/Developer/proof/packages/docs/.docz
yarn run v1.16.0
error Command "build" not found.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

If you first run docz dev, the .docz folder is created and the docz build command now succeeds

Expected behavior

It builds from a clean state (like on CI builds)

Environment

• OS: OSX 10.14.5
• Node/npm version: [email protected] [email protected]

[bricelp]

This is a serious issue we have here... How are we supposed to use this project if we cannot build it from a CI env ?

[rakannimer]

Hey,

Maybe not an ideal solution, but you can fix it by running docz dev before building on CI.

To do that :

Add wait-on and kill-port to dev dependencies :

yarn add -D wait-on kill-port # npm i -D wait-on kill-port

Add a build:ci command in package.json :

{
    "scripts": {
        "build": "docz build",
        "build:ci": "kill-port 3000 && (npm run dev &) && wait-on http-get://localhost:3000 && kill-port 3000 && npm run build"
    }
}

And you should be able to build without having a .docz folder.

[bricelp]

Hi, many thanks. We were thinking about something that way to test it on a CI too but as you said, it's obviously not a sustainable solution regarding of the size and time gatsby take to start on first run.

We'll keep waiting for the moment until @pedronauck provide a proper way to build this package :)

[levithomason]

There's far too much magic in the docz dev command and .docz directory, like installing deps there and creating folders. Would be great to see it not install its own deps on every run and allow the docs build command to run without requiring docz dev first.

[rakannimer]

Hey @levithomason,

I agree with you the build command should be smarter and not need docz dev to be called first.

I plan to get on that as soon as I finish fixing critical v2 issues 👍

This is also tracked here : #1049

Regarding installing its own deps on every run, I think we can get rid of that pretty easily.

Will get on that later, or if someone would like to create a PR I'd be happy to merge.

[rakannimer]

Hey all !

Thanks @bricelp, @levithomason and @adierkens for raising this issue.

Starting from versions >= 2.0.0-rc.33, docz doesn't install any dependency in the .docz folder 🎉 !

Try out the latest version :

rm -rf .docz && yarn add docz@next && yarn docz dev # or yarn docz build

Would be great to see it not install its own deps on every run

Docz doesn't do that anymore 👍 .

allow the docs build command to run without requiring docz dev first

You can now do that too ! docz build doesn't require docz dev to be called first !

[rakannimer]

Closing for inactivity.
Feel free to re-open if the issue reoccurs.

[brandonarbini]

@rakannimer Probably deserves its own issue, but I've just discovered that when running build before dev, it will not copy over custom src files (like custom gatsby-theme-docz files). I tried to pre-create the .docz folder with my custom Gatsby theme and it caused some sort of infinite loop when running either build or dev.

[rakannimer]

Thanks @brandonarbini for reporting.

Definitely worth it's own issue, I think it's being tracked in https://github.com/doczjs/docz/issues/1105

The fix, as you said, is to copy the base directory (defaults to src) to .docz before building and not rely on dev being run before.

If you'd like to submit a PR to fix it I'd be happy to help/review/merge.

If you can't, no problem. I'll get to it later this week !