rusefi / rusefi_documentation

User documentation for rusEFI engine control unit
GNU General Public License v3.0
25 stars 30 forks source link

nightly build for WIKI with full validation enabled to catch errors early #479

Closed mi-hol closed 1 year ago

mi-hol commented 1 year ago

Currently only changed documents are rebuild and validated. Some changes like bulk-updates of links including deletes of obsolete file go unnoticed for their unintentional side effects until a user complains or a change in an affected file occured.

Proposal:

chuckwagoncomputing commented 1 year ago
  1. lint.sh is supposed to check for broken links on all files if any files have been deleted or renamed. Do you have an example of it not working properly?
  2. Wiki3 is fully built on every push to master.
mi-hol commented 1 year ago

my PR https://github.com/rusefi/rusefi_documentation/pull/426 deleted files in commit https://github.com/rusefi/rusefi_documentation/pull/426/commits/593697fe7346ed5a6675511e49d13cc2abc555ae that had negative side effects for files fixed by Andrey's commit https://github.com/rusefi/rusefi_documentation/commit/9687323aaa2f0c613fe6875c2d59ac2bd1cd4159

chuckwagoncomputing commented 1 year ago

Oh I see now that it didn't actually run a full check if files were deleted, only if they were renamed or moved. https://github.com/rusefi/rusefi_documentation/pull/481

mi-hol commented 1 year ago
  • build to a temporary location
  • the output is only copied from temporary location to production WIKI site when no errors are found

is there any chance this could be implemented?

chuckwagoncomputing commented 1 year ago

Why is requiring lint to pass before merging a PR not sufficient?

rusefillc commented 1 year ago

Why is requiring lint to pass before merging a PR not sufficient?

In reality I am definitely guilty of pushing outside of PR process, and so far I am planning to keep editing directly :( Not trying to stir anything just stating the facts.

mi-hol commented 1 year ago

makes no sense