sbp commented on PR #481: URL: https://github.com/apache/tooling-trusted-releases/pull/481#issuecomment-3739395062
This is looking much improved, thank you! A few notes: * We use [sentence case for headings](https://release-test.apache.org/docs/code-conventions#html), like Wikipedia * Our user guide is being split into pages. For example, we have a [signing artifacts page](https://release-test.apache.org/docs/signing-artifacts). I think it would be better if the checks documentation were moved to its own page like this * We now allow users to decide between only running lightweight checks, only running RAT checks, or running both. This only applies to source artifact checks. Binary artifacts are always checks by the lightweight checks and there is no way to turn them off. We should mention this prominently in the guide * "Projects can define custom exclusions by placing a `.rat-excludes` file in the root of the archive." The behaviour here is actually quite particular: there can only be one `.rat-excludes` file and it can be anywhere, but that directory then becomes the scan root. Importantly, there must be no files outside of the scan root. (We might have to relax this if we find that e.g. OS metadata files are appearing outside of the scan root, but the easiest fix is to put the file in the actual archive root) * The "Automatically Excluded Patterns" apply to lightweight checks now as well as RAT checks. That is due to the work I did for #427 * The documentation doesn't mention the outcome of #274, the work that I did on adding the new exclusion release policy fields. The PR was blocking on that issue specifically because that information needs to be in the documentation * Thank you for mentioning the standard exclusions for RAT. We should also probably mention that they don't apply when a `.rat-excludes` file is present * The PR currently contains 3 commits. Could you always squash it down to a single commit please? This documentation change doesn't need more than a single commit The lints are also [still failing](https://github.com/apache/tooling-trusted-releases/actions/runs/20883554446/job/60124391766?pr=481): ``` 0.245 uv run --frozen python3 scripts/docs_check.py 0.387 Documentation link validation errors: 0.387 0.387 user-guide.md:16: Link to non-existent anchor '#license-checks--exclusions' in 'user-guide' 0.387 0.387 Found 1 error 0.402 make: *** [Makefile:68: docs] Error 1 ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
