[DOCS-58] Linting of a docs project job should be done on files within the patchset Created: 21/Dec/17 Updated: 06/Mar/18 Resolved: 06/Mar/18 |
|
| Status: | Closed |
| Project: | docs |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Improvement | Priority: | Medium |
| Reporter: | Kit Lou | Assignee: | Thanh Ha (zxiiro) |
| Resolution: | Won't Do | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Description |
|
For a docs project job, the linter (coala) checks should be applied only to the files within the patchset and not on other files. For other projects with rst files, the linter (coala) should be applied and prevent files with errors and applicable warnings from being merged. |
| Comments |
| Comment by Thanh Ha (zxiiro) [ 27/Dec/17 ] |
|
This is not possible today unless someone wants to work with upstream likely Coala project and whatever specific linters we're using to add such a feature. Personally I prefer that it scans all of the files for every run to prevent a situation where we're not following spec in some files that haven't been touched in awhile. This ensures that when we upgrade linter versions that we are always following the latest best practices. Individual files can be ignored by the linter via the excludes line as a last resort. |
| Comment by Thanh Ha (zxiiro) [ 09/Jan/18 ] |
|
We decided to look into splitting the docs verify job to individual projects at some point in the future. |
| Comment by Charles La Voy [ 06/Mar/18 ] |
|
Splitting out the submodules, which should help with this issue. |