renovatebot / renovatebot.github.io

Auto-generating docs repository for Renovate Bot
https://docs.renovatebot.com
44 stars 37 forks source link

chore: allow non-strict build #509

Closed viceice closed 1 month ago

viceice commented 1 month ago

Changes:

Allow non-strict build via make build-docs STRICT=false and disable strict on gitpod and devcontainer startup.

Context:

HonkingGoose commented 1 month ago

The goal I have is to:

The question is, are we actually --strict on builds on the main repository?

Here's the startpoint:

https://github.com/renovatebot/renovate/blob/833df8e32ba2fc0a0e3b835b0a0face42a6cb49c/.github/workflows/build.yml#L597-L600

Which leads to:

https://github.com/renovatebot/renovate/blob/main/package.json#L14

Which points to:

https://github.com/renovatebot/renovate/blob/main/tools/mkdocs.ts

I don't see strict mentioned in tools/mkdocs.ts, but there is some custom error handling. Maybe that catches any errors, and fails the build if there is a error?

https://github.com/renovatebot/renovate/blob/833df8e32ba2fc0a0e3b835b0a0face42a6cb49c/tools/mkdocs.ts#L34-L42

viceice commented 1 month ago

The goal I have is to:

  • Allow non-strict builds for Devcontainer and Gitpod
  • Build strict in the main renovatebot/renovate repository, so we don't publish bad stuff on renovatebot/renovatebot.github.io

The question is, are we actually --strict on builds on the main repository?

Here's the startpoint:

https://github.com/renovatebot/renovate/blob/833df8e32ba2fc0a0e3b835b0a0face42a6cb49c/.github/workflows/build.yml#L597-L600

Which leads to:

https://github.com/renovatebot/renovate/blob/main/package.json#L14

Which points to:

https://github.com/renovatebot/renovate/blob/main/tools/mkdocs.ts

I don't see strict mentioned in tools/mkdocs.ts, but there is some custom error handling. Maybe that catches any errors, and fails the build if there is a error?

https://github.com/renovatebot/renovate/blob/833df8e32ba2fc0a0e3b835b0a0face42a6cb49c/tools/mkdocs.ts#L34-L42

https://github.com/renovatebot/renovate/pull/30776

the make file is adding --strict to the mkdocs command if not explicit opted out