[
https://issues.apache.org/jira/browse/FLINK-12358?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16828843#comment-16828843
]
Chesnay Schepler commented on FLINK-12358:
------------------------------------------
I doubt that a diff-based approach will work here properly. For one there's a
maintenance overhead, since every new relevant file (i.e. header) must be
covered, but their location is arbitrary. You'd also have to check whether
changes in the file actually change semantics; for example a javadoc change
doesn't require regeneration.
Given that we already have utilities for reading/writing Rest API snapshots
(see RestAPIStabilityTest) and examples for parsing the existing html (see
ConfigOptionsCompletenessTest), I'd be very much in favor of a similar approach.
> Verify whether rest documenation needs to be updated when building pull
> request
> -------------------------------------------------------------------------------
>
> Key: FLINK-12358
> URL: https://issues.apache.org/jira/browse/FLINK-12358
> Project: Flink
> Issue Type: Improvement
> Components: Build System
> Reporter: Yun Tang
> Assignee: Yun Tang
> Priority: Minor
>
> Currently, unlike configuration docs, rest-API docs have no any methods to
> check whether updated to latest code. This is really annoying and not easy to
> track if only checked by developers.
> I plan to check this in travis to verify whether any files have been updated
> by using `git status`.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
