Skip to content

Deploy user docs only from main MarkBind repository#817

Merged
yamgent merged 2 commits into
MarkBind:masterfrom
Xenonym:devops/deploy-on-repo
Apr 5, 2019
Merged

Deploy user docs only from main MarkBind repository#817
yamgent merged 2 commits into
MarkBind:masterfrom
Xenonym:devops/deploy-on-repo

Conversation

@Xenonym

@Xenonym Xenonym commented Apr 5, 2019

Copy link
Copy Markdown
Contributor

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 on condition to only attempt to deploy user docs when Travis CI runs on the MarkBind/markbind repository. 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:

  1. Pull this PR to your own fork, and test with Travis CI enabled. It should not deploy even when on a tagged commit that matches vx.x.x.

Proposed commit message: (wrap lines at 72 characters)

Deploy user docs only from main MarkBind repo

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.
Docs: add steps for deploying from specific repo

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.

Xenonym added 2 commits April 5, 2019 13:33
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.
@Xenonym Xenonym changed the title Devops/deploy on repo Deploy user docs only from main MarkBind repository Apr 5, 2019
@yamgent yamgent added this to the v2.1.1 milestone Apr 5, 2019
@yamgent yamgent merged commit c3d26e0 into MarkBind:master Apr 5, 2019
@yamgent

yamgent commented Apr 5, 2019

Copy link
Copy Markdown
Member

Thanks for this PR, Travis now no longer complains about deployment errors on my fork. 👍

@Xenonym Xenonym deleted the devops/deploy-on-repo branch April 5, 2019 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Travis user docs deployment: restrict deployment to only from MarkBind/markbind

2 participants