Skip to content
This repository has been 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
wants to merge 1 commit into
base: staging
Choose a base branch
from

Conversation

benpankow
Copy link
Contributor

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.

Copy link
Member

@PradyumnaShome PradyumnaShome left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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}" ]] \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we simplify this logic into separate variables which make it clear what each expression signifies?
This is currently hard to read.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants