Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve message when docs are out-of-date. #1194

Merged
merged 1 commit into from
Jun 22, 2021
Merged

Improve message when docs are out-of-date. #1194

merged 1 commit into from
Jun 22, 2021

Commits on Jun 22, 2021

  1. Improve message when docs are out-of-date. 

    Checking in generated build artifacts makes things harder for contributors. The get a red CI status but have to know to look at the definition of the diff_test target to discover there's a command to auto-update. Instead we just print that command on failure.

The failure now looks like this:

```
$ bazel test //doc:all
INFO: Analyzed 9 targets (0 packages loaded, 0 targets configured).
INFO: Found 9 test targets...
FAIL: //doc:check_ios.doc (see /home/alexeagle/.cache/bazel/_bazel_alexeagle/32c0f21b6a1d2ed917381b593d4bcb34/execroot/build_bazel_rules_apple/bazel-out/k8-fastbuild/testlogs/doc/check_ios.doc/test.log)
INFO: From Testing //doc:check_ios.doc:
==================== Test output for //doc:check_ios.doc:
393c393
< | <a id="ios_sticker_pack_extension-entitlements"></a>entitlements |  The entitlements file required for device builds of this target. If absent, the default entitlements from the provisioning profile will be used.<br><br>The following variables are substituted in the entitlements file: <code>$(CFBundleIdentifier)</code> with the bundle ID of the application and <code>$(AppIdentifierPrefix)</code> with the value of the <code>ApplicationIdentifierPrefix</code> key from the target's provisioning profile.   | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | optional | None |
---
> | <a id="ios_sticker_pack_extension-entitlements"></a>entitlements |  The entitlements file required for device builds of this target. If absent, the default entitlements from the provisioning profile will be used.<br><br>The following variables are substituted in the entitlements file: <code>$(CFBundleIdentifier)</code> with the bundle ID of the application and <code>$(AppIdentifierPrefix)</code> with the value of the <code>ApplicationIdentifierPrefixe</code> key from the target's provisioning profile.   | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | optional | None |
FAIL: files "doc/ios.doc.md" and "doc/rules-ios.md" differ.
Please update the docs by running
    bazel run //doc:update
================================================================================
INFO: Elapsed time: 0.067s, Critical Path: 0.02s
```
    @alexeagle
    alexeagle committed Jun 22, 2021
    Configuration menu
    Copy the full SHA
    5f98726 View commit details
    Browse the repository at this point in the history