You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When running norska init in ./docs/ when in a monorepo setup, some files could be created in a better place. The initial code was meant with the assumption that the git root was the same as the module root (ie. package.json file is sitting next to .git folder).
In a mono-repo setup:
There is a repoRoot, where the .git folder is, as well as the main package.json
There is a projectRoot, that can be a subfolder of the repoRoot, and might have its own package.json
The following points should be addressed:
netlify.toml
The netlify.toml file should be created in the repoRoot, not the projectRoot. Netlify operates on the repository level, listening to events on the repo. This will be our job to make sure a job is started only when the documentation is updated.
[build]
command = "yarn run build:prod"
publish = "./docs/dist/"
The command might stay build:prod and point to a script in the root that builds the ./docs folder. The publish directory must point to the subfolder.
⚠ Maybe the commands involving the netlify cli will need a netlify.toml in the docs/ folder. We need to check.
.gitignore
The .netlify/ folder is added to the current .gitignore, but because there is no such file in the project root, a new one is created. It should add .netlify to the .gitignore in the repoRoot instead.
The text was updated successfully, but these errors were encountered:
When running
norska init
in./docs/
when in a monorepo setup, some files could be created in a better place. The initial code was meant with the assumption that the git root was the same as the module root (ie.package.json
file is sitting next to.git
folder).In a mono-repo setup:
repoRoot
, where the.git
folder is, as well as the mainpackage.json
projectRoot
, that can be a subfolder of therepoRoot
, and might have its ownpackage.json
The following points should be addressed:
netlify.toml
The
netlify.toml
file should be created in therepoRoot
, not theprojectRoot
. Netlify operates on the repository level, listening to events on the repo. This will be our job to make sure a job is started only when the documentation is updated.The command might stay
build:prod
and point to a script in the root that builds the ./docs folder. The publish directory must point to the subfolder.⚠ Maybe the commands involving the netlify cli will need a netlify.toml in the docs/ folder. We need to check.
.gitignore
The
.netlify/
folder is added to the current.gitignore
, but because there is no such file in the project root, a new one is created. It should add.netlify
to the.gitignore
in therepoRoot
instead.The text was updated successfully, but these errors were encountered: