Improve message when docs are out-of-date. #1194
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
the failure appears related |
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 ```
|
added the patch into the "HEAD" version of bazel-skylib as well. Not sure if we have much chance of getting the upstream PR merged? We could sit on this one a few more days and see if we get the new attribute added to bazel-skylib at HEAD... |
keith
approved these changes
Jun 22, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: