@@ -79,33 +79,36 @@ $ make test-bytecomp
79
79
80
80
#### Running the tests in Travis CI
81
81
82
- If you prefer to see the full Travis test suite run successfully, the easiest
82
+ If you prefer to see the full Travis CI test suite run successfully, the easiest
83
83
way to achieve that is to create your own personal account on
84
- https://travis-ci.org . View your profile details on the Travis site, and toggle
85
- the switch to enable builds on your fork of the cider project.
84
+ https://travis-ci.org . View your profile details on the Travis CI site, and
85
+ toggle the switch to enable builds on your fork of the cider project.
86
86
87
- Subsequent pushes to your fork will generate a Travis build you can monitor for
88
- success or failure.
87
+ Subsequent pushes to your fork will generate a Travis CI build you can monitor
88
+ for success or failure.
89
89
90
- #### Simulating the Travis tests locally in Docker
90
+ #### Simulating the Travis CI tests locally in Docker
91
91
92
- If you prefer not to wait for Travis all the time, or if you need to debug
93
- something that fails in Travis but does not fail for you on your own machine,
94
- then you can also run the Travis tests manually in Docker.
92
+ If you prefer not to wait for Travis CI all the time, or if you need to debug
93
+ something that fails in Travis CI but does not fail for you on your own machine,
94
+ then you can also run the Travis CI tests manually in Docker.
95
95
96
96
You will need to run some scripts to build and launch the Docker image.
97
97
98
98
To build:
99
+
99
100
```
100
101
$ docker/build.sh
101
102
```
102
103
103
- The build script uses a base image provided by the engineers at Travis. Note: the
104
- Travis docker image is currently more than 8GB, so be prepared with a good
105
- internet connection and time to spare.
104
+ The build script uses a base image provided by the engineers at Travis CI.
105
+
106
+ * Note: The Travis docker image is currently more than 8GB, so be prepared with a
107
+ good internet connection and time to spare.*
106
108
107
109
The resulting docker image is tagged simply ` cider-travis ` . You can run this
108
110
image by hand, but there is a convenience script available:
111
+
109
112
```
110
113
$ docker/run.sh
111
114
```
@@ -114,20 +117,22 @@ This script launches a docker container and bind-mounts your cider project
114
117
directory as ` /home/travis/cider ` such that you can instantly see any code
115
118
changes reflected inside the docker environment.
116
119
117
- For instance, you can run tests on emacs 25.3
120
+ For instance, first you can run tests on Emacs 25.3:
121
+
118
122
```
119
123
(emacs-25.3-travis) ~/cider$ make test
120
124
```
121
125
122
- and then switch to emacs 26 and test again
126
+ And then switch to Emacs 26.1 and test again:
123
127
124
128
```
125
- (emacs-25.3-travis) ~/cider$ evm use emacs -26-pretest-travis
129
+ (emacs-25.3-travis) ~/cider$ evm use Emacs -26-pretest-travis
126
130
(emacs-26-pretest-travis) ~/cider$ cask install
127
131
(emacs-26-pretest-travis) ~/cider$ make test
128
132
```
129
133
130
134
You can test byte compilation too
135
+
131
136
```
132
137
(emacs-26-pretest-travis) ~/cider$ make test-bytecomp
133
138
```
@@ -138,9 +143,9 @@ container will also exit. Note that `docker/run.sh` runs the container with
138
143
container exits.
139
144
140
145
So for example, by default, the docker image pre-installs only the most recent
141
- releases of emacs 25, emacs 26, and a recent snapshot of the emacs git
146
+ releases of Emacs 25, Emacs 26, and a recent snapshot of the Emacs git
142
147
repository. The ` evm ` tool is available should you need to install some other
143
- specific build. However additional versions of emacs will be discarded when
148
+ specific build. However additional versions of Emacs will be discarded when
144
149
you exit the docker container.
145
150
146
151
## Hacking on cider-nrepl
0 commit comments