Deploy user docs only from main MarkBind repository#817
Merged
Conversation
Our Travis CI configuration will attempt to deploy our user docs from any repository, including forks. This can lead to accidental overwriting of the user docs from developer forks if they have write access to the user docs repository. Let's add a `on` condition to our Travis CI configuration to specify that deployment of the user docs should only be done when run from the main MarkBind repository.
Restricting Travis CI to only deploy a MarkBind site from a main project repository should be quite a common use case for projects using MarkBind. Let's document how to restrict Travis CI deployment to a specific repository in our user documentation.
yamgent
approved these changes
Apr 5, 2019
Member
|
Thanks for this PR, Travis now no longer complains about deployment errors on my fork. 👍 |
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 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.
What is the purpose of this pull request? (put "X" next to an item, remove the rest)
• [X] Other, please explain: DevOps enhancement
Closes #749.
What is the rationale for this request?
Our Travis CI configuration will attempt to deploy our user docs from any repository, including forks. This can lead to accidental overwriting of the user docs from developer forks if they have write access to the user docs repository.
What changes did you make? (Give an overview)
I added a
oncondition to only attempt to deploy user docs when Travis CI runs on theMarkBind/markbindrepository. Since this is a common use case, I have also added instructions on how to restrict Travis CI to only deploy from a a specific repository to the user documentation.Is there anything you'd like reviewers to focus on?
Is the user documentation for restricting Travis CI to only deploy from a a specific repository clear?
Testing instructions:
vx.x.x.Proposed commit message: (wrap lines at 72 characters)