summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorstevegt <stevegt@t7a.org>2019-03-18 01:38:08 +0100
committerLunny Xiao <xiaolunwen@gmail.com>2019-03-18 08:38:08 +0800
commitcd8cdbd9d29b2c8c49102f30a0af98378af43777 (patch)
treefa4a6c95042e910af812435b7077b665af4bfde1 /CONTRIBUTING.md
parent1155f1b02ddd1fbe1d51d53debf6c4e6e29acc91 (diff)
downloadgitea-cd8cdbd9d29b2c8c49102f30a0af98378af43777.tar.gz
gitea-cd8cdbd9d29b2c8c49102f30a0af98378af43777.zip
fix testing instructions in CONTRIBUTING.md (#6305)
* add scripts/test-local.sh and fix CONTRIBUTING.md - fixes #6243 - partial fix for #6269 Signed-off-by: Steve Traugott <stevegt@t7a.org> * remove reference to possible automated drone run * remove bash version of drone-cli test script * fix issue number links in testing instructions * remove scripts/test-local.sh
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md29
1 files changed, 20 insertions, 9 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index bcee101f5f..64b3d28d6b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -64,15 +64,26 @@ high-level discussions.
## Testing redux
-Before sending code out for review, run all the tests for the
-whole tree to make sure the changes don't break other usage
-and keep the compatibility on upgrade. To make sure you are
-running the test suite exactly like we do, you should install
-the CLI for [Drone CI](https://github.com/drone/drone), as
-we are using the server for continuous testing, following [these
-instructions](http://docs.drone.io/cli-installation/). After that,
-you can simply call `drone exec --local --build-event "pull_request"` within
-your working directory and it will try to run the test suite locally.
+Before submitting a pull request, run all the tests for the whole tree
+to make sure your changes don't cause regression elsewhere.
+
+Here's how to run the test suite:
+
+- Install the correct version of the drone-cli package. As of this
+ writing, the correct drone-cli version is
+ [0.8.6](https://0-8-0.docs.drone.io/cli-installation/).
+- Ensure you have enough free disk space. You will need at least
+ 15-20 Gb of free disk space to hold all of the containers drone
+ creates (a default AWS or GCE disk size won't work -- see
+ [#6243](https://github.com/go-gitea/gitea/issues/6243)).
+- Change into the base directory of your copy of the gitea repository,
+ and run `drone exec --local --build-event pull_request`.
+
+The drone version, command line, and disk requirements do change over
+time (see [#4053](https://github.com/go-gitea/gitea/issues/4053) and
+[#6243](https://github.com/go-gitea/gitea/issues/6243)); if you
+discover any issues, please feel free to send us a pull request to
+update these instructions.
## Vendoring