This repository was archived by the owner on Dec 7, 2023. It is now read-only.
Add Travis script to verify that docs were updated for PRs which modify services#262
Open
Add Travis script to verify that docs were updated for PRs which modify services#262
Conversation
PradyumnaShome
suggested changes
Jan 16, 2020
Member
PradyumnaShome
left a comment
PradyumnaShome
left a comment
There was a problem hiding this comment.
Great idea to add some more automation! I have suggested a style change so the script becomes easier to maintain.
| service_upper=${service^} | ||
|
|
||
| # check if any file in the service has been changed and if the doc page has not been changed | ||
| if [[ $changed_files =~ "services/${service}" ]] \ |
Member
There was a problem hiding this comment.
Can we simplify this logic into separate variables which make it clear what each expression signifies?
This is currently hard to read.
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
Addresses #252, in part. Creates a bot which validates that relevant documentation files are updated in each PR which modifies files for a particular service. If docs are not updated, a bot will leave a comment on the PR as a reminder. Users can ignore the comment if their PR does not adjust functionality.