paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-24 00:23:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update docs/git/ directory to reflect CI changes.

Browse Source 
This isn't complete, in that we still need to rename the ReadTheDocs
articles (e.g.).
This commit is contained in:
Vishnu Ks
2018-12-10 21:42:58 +05:30
committed by Tim Abbott
parent 15d4b71e2e
commit c3aa7909ce
7 changed files with 38 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/development/overview.md
View File

@@ -76,7 +76,7 @@ Once you've installed the Zulip development environment, you'll want
to read these documents to learn how to use it: to read these documents to learn how to use it:
* [Using the Development Environment][using-dev-env] * [Using the Development Environment][using-dev-env]
* [Testing][testing] (and [Configuring Travis CI][travis-ci]) * [Testing][testing] (and [Configuring CI][ci])
And if you've setup the Zulip development environment on a remote And if you've setup the Zulip development environment on a remote
machine, take a look at our tips for machine, take a look at our tips for
@@ -92,4 +92,4 @@ machine, take a look at our tips for
[configure-proxy]: ../development/setup-vagrant.html#specifying-a-proxy [configure-proxy]: ../development/setup-vagrant.html#specifying-a-proxy
[using-dev-env]: using.html [using-dev-env]: using.html
[testing]: ../testing/testing.html [testing]: ../testing/testing.html
[travis-ci]: ../git/cloning.html#step-3-configure-travis-ci-continuous-integration [ci]: ../git/cloning.html#step-3-configure-continuous-integration-for-your-fork

4
docs/development/setup-vagrant.md
View File

@@ -592,7 +592,7 @@ Next, read the following to learn more about developing for Zulip:
* [Git & GitHub Guide][rtd-git-guide] * [Git & GitHub Guide][rtd-git-guide]
* [Using the Development Environment][rtd-using-dev-env] * [Using the Development Environment][rtd-using-dev-env]
* [Testing][rtd-testing] (and [Configuring Travis CI][travis-ci] to * [Testing][rtd-testing] (and [Configuring CI][ci] to
run the full test suite against any branches you push to your fork, run the full test suite against any branches you push to your fork,
which can help you optimize your development workflow). which can help you optimize your development workflow).
@@ -1061,4 +1061,4 @@ for the IP address that means any IP address can connect to your development ser
[git-bash]: https://git-for-windows.github.io/ [git-bash]: https://git-for-windows.github.io/
[bash-admin-setup]: https://superuser.com/questions/1002262/run-applications-as-administrator-by-default-in-windows-10 [bash-admin-setup]: https://superuser.com/questions/1002262/run-applications-as-administrator-by-default-in-windows-10
[set-up-git]: ../git/setup.html [set-up-git]: ../git/setup.html
[travis-ci]: ../git/cloning.html#step-3-configure-travis-ci-continuous-integration [ci]: ../git/cloning.html#step-3-configure-continuous-integration-for-your-fork

40
docs/git/cloning.md
View File

@@ -99,33 +99,48 @@ If you haven't already, now is a good time to install the Zulip development envi
source projects in general, we recommend following our [detailed guide for source projects in general, we recommend following our [detailed guide for
first-time contributors][zulip-rtd-dev-first-time]. first-time contributors][zulip-rtd-dev-first-time].
## Step 3: Configure Travis CI (continuous integration) ## Step 3: Configure continuous integration for your fork
This step is optional, but recommended. This step is optional, but recommended.
The Zulip Server project is configured to use [Travis CI][travis-ci] The Zulip Server project is configured to use [Circle CI][circle-ci]
to test and create builds upon each new commit and pull and [Travis CI][travis-ci] to test and create builds upon each new commit
request. Travis CI is free for open source projects and it's easy to and pull request. CircleCI is the primary CI that runs frontend and backend
configure for your own fork of Zulip. After doing so, Travis CI will tests across a wide range of Ubuntu distributions. Travis CI is used only for
run tests for new refs you push to GitHub and email you the outcome running the end-to-end production installer test.
CircleCI and Travis CI are free for open source projects and it's easy to
configure for your own fork of Zulip. After doing so, CircleCI and Travis
CI will run tests for new refs you push to GitHub and email you the outcome
(you can also view the results in the web interface). (you can also view the results in the web interface).
Running Travis CI against your fork can help save both you and the Running CI against your fork can help save both your and the
Zulip maintainers time by making it easy to test a change fully before Zulip maintainers time by making it easy to test a change fully before
submitting a pull request. We generally recommend a worfklow where as submitting a pull request. We generally recommend a worfklow where as
you make changes, you use a fast edit-refresh cycle running individual you make changes, you use a fast edit-refresh cycle running individual
tests locally until your changes work. But then once you've gotten tests locally until your changes work. But then once you've gotten
the tests you'd expect to be relevant to your changes working, push a the tests you'd expect to be relevant to your changes working, push a
branch to Travis CI to run the full test suite before you create a branch to run the full test suite in CircleCI and Travis CI before
pull request. While you wait for Travis CI to run, you can start you create a pull request. While you wait for CircleCI and Travis CI
working on your next task. When the tests finish, you can create a to run, you can start working on your next task. When the tests finish,
pull request that you already know passes the tests. you can create a pull request that you already know passes the tests.
### Setup CircleCI
First, sign in to [Circle CI][circle-ci] with your GitHub account and authorize
CircleCI to access your GitHub account and repositories. Once you've logged
in click on **Add Projects** in right sidebar. This will list all your GitHub
repositories. Now goto the row of Zulip and click on **Set Up Project**.
![Screencast of CircleCI setup](../images/zulip-circleci.gif)
### Setup Travis CI
First, sign in to [Travis CI][travis-ci] with your GitHub account and authorize First, sign in to [Travis CI][travis-ci] with your GitHub account and authorize
Travis CI to access your GitHub account and repositories. Once you've done Travis CI to access your GitHub account and repositories. Once you've done
this, Travis CI will fetch your repository information and display it on your this, Travis CI will fetch your repository information and display it on your
[profile page][travis-ci-profile]. From there you can enable integration with [profile page][travis-ci-profile]. From there you can enable integration with
Zulip. ([See screen cast](../_static/zulip-travisci.gif).) Zulip.
![Screencast of Travis CI setup](../_static/zulip-travisci.gif)
[gitbook-rebase]: https://git-scm.com/book/en/v2/Git-Branching-Rebasing [gitbook-rebase]: https://git-scm.com/book/en/v2/Git-Branching-Rebasing
[github-help-add-ssh-key]: https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/ [github-help-add-ssh-key]: https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/
@@ -135,6 +150,7 @@ Zulip. ([See screen cast](../_static/zulip-travisci.gif).)
[github-zulip]: https://github.com/zulip/ [github-zulip]: https://github.com/zulip/
[github-zulip-zulip]: https://github.com/zulip/zulip/ [github-zulip-zulip]: https://github.com/zulip/zulip/
[travis-ci]: https://travis-ci.org/ [travis-ci]: https://travis-ci.org/
[circle-ci]:https://circleci.com/
[travis-ci-profile]: https://travis-ci.org/profile [travis-ci-profile]: https://travis-ci.org/profile
[zulip-rtd-dev-first-time]: ../development/setup-vagrant.html [zulip-rtd-dev-first-time]: ../development/setup-vagrant.html
[zulip-rtd-dev-overview]: ../development/overview.html [zulip-rtd-dev-overview]: ../development/overview.html

4
docs/git/overview.md
View File

@@ -46,7 +46,7 @@ with these details in mind:
tasks of testing other contributors' pull requests to single commands. tasks of testing other contributors' pull requests to single commands.
Finally, install the [Zulip developer environment][zulip-rtd-dev-overview], and then Finally, install the [Zulip developer environment][zulip-rtd-dev-overview], and then
[configure your fork for use with Travis CI][zulip-git-guide-travisci]. [configure continuous integration for your fork][zulip-git-guide-fork-ci].
*** ***
@@ -59,7 +59,7 @@ git workflow, or if you'd like a git refresher.
[github-zulip]: https://github.com/zulip/ [github-zulip]: https://github.com/zulip/
[github-zulip-zulip]: https://github.com/zulip/zulip/ [github-zulip-zulip]: https://github.com/zulip/zulip/
[travis-ci]: https://travis-ci.org/ [travis-ci]: https://travis-ci.org/
[zulip-git-guide-travisci]: ../git/cloning.html#step-3-configure-travis-ci-continuous-integration [zulip-git-guide-fork-ci]: ../git/cloning.html#step-3-configure-continuous-integration-for-your-fork
[zulip-rtd-code-style]: ../contributing/code-style.html [zulip-rtd-code-style]: ../contributing/code-style.html
[zulip-rtd-commit-discipline]: ../contributing/version-control.html#commit-discipline [zulip-rtd-commit-discipline]: ../contributing/version-control.html#commit-discipline
[zulip-rtd-commit-messages]: ../contributing/version-control.html#commit-messages [zulip-rtd-commit-messages]: ../contributing/version-control.html#commit-messages

6
docs/git/zulip-tools.md
View File

@@ -29,9 +29,9 @@ $ ls -l .git/hooks
pre-commit -> ../../tools/pre-commit pre-commit -> ../../tools/pre-commit
``` ```
## Set up Travis CI integration ## Configure continuous integration for your Zulip fork
You might also wish to [configure your fork for use with Travis CI][zulip-git-guide-travisci]. You might also wish to [configure continuous integration for your fork][zulip-git-guide-ci].
## Reset to pull request ## Reset to pull request
@@ -149,4 +149,4 @@ git rebase --continue
[github-zulip-zulip]: https://github.com/zulip/zulip/ [github-zulip-zulip]: https://github.com/zulip/zulip/
[zulip-git-guide-fetch-pr]: ../git/collaborate.html#checkout-a-pull-request-locally [zulip-git-guide-fetch-pr]: ../git/collaborate.html#checkout-a-pull-request-locally
[zulip-git-guide-travisci]: ../git/cloning.html#step-3-configure-travis-ci-continuous-integration [zulip-git-guide-ci]: ../git/cloning.html#step-3-configure-continuous-integration-for-your-fork

BIN
docs/images/zulip-circleci.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 515 KiB

2
docs/testing/travis.md
View File

@@ -70,7 +70,7 @@ our configuration, you'll want to look at these closely.
that every remote branch you push will be tested, which can be that every remote branch you push will be tested, which can be
helpful when debugging something complicated. helpful when debugging something complicated.
[travis-fork]: ../git/cloning.html#step-3-configure-travis-ci-continuous-integration [travis-fork]: ../git/cloning.html#step-3-configure-continuous-integration-for-your-fork
## Performance optimizations ## Performance optimizations