Skip to content

Commit 5d65d67

Browse files
committed
Add build environment
Added a Dockerfile to describe the canonical build environment and added relevant comments to the README
1 parent d669971 commit 5d65d67

File tree

2 files changed

+23
-5
lines changed

2 files changed

+23
-5
lines changed

Dockerfile

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
FROM ubuntu:xenial
2+
RUN apt update
3+
RUN apt install openjdk-8-jdk -y
4+
RUN apt install maven -y
5+
VOLUME /src
6+
WORKDIR /src
7+
CMD "bash"

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -135,13 +135,13 @@ FAQ
135135
Also, the people behind Spring rock. I felt like I was selling tickets to the concert of rockstars by releasing
136136
this.
137137

138-
3. What is the main design decision behind this framework?
138+
3. What is the main design principle behind this framework?
139139

140140
> Make you do as little as possible.
141141

142142
4. When should I use this?
143143

144-
> You should only use this to write you *unit* tests. For anything else, you would want the whole application to
144+
> You should only use this to write your *unit* tests. For anything else, you would want the whole application to
145145
come alive and work. Using mocks for that is a bad idea.
146146

147147
5. This is going to be used at the level of code testing. Is it really well written?
@@ -154,7 +154,7 @@ Some Numbers and Facts
154154

155155
* This project has *1000+* individual unit tests.
156156

157-
* This project has **100%** [code coverage](https://coveralls.io/github/mmnaseri/spring-data-mock)
157+
* This project has effective **100%** (deprecated code is not tested) [code coverage](https://coveralls.io/github/mmnaseri/spring-data-mock)
158158

159159
* This project has **95%** branch coverage rate.
160160

@@ -171,8 +171,8 @@ Some Numbers and Facts
171171
Contribution
172172
------------
173173

174-
Since this project is aimed at the testing phase of your code, it is paramount that it is written with the best of
175-
qualities and that it maintains the highest standard.
174+
Since this project aims to help you in the testing phase of your code, it is paramount that it is
175+
written with the best of qualities and that it maintains the highest standard.
176176

177177
Contributors are more than welcome. In fact, I flag most of the issues I receive as `help wanted` and
178178
there are really generous people out there who do take care of some issues.
@@ -181,6 +181,17 @@ If you see a piece of code that you don't like for whatever reason -- so long as
181181
by pioneers and standards -- feel free to dig in and change the code to your heart's content and create a
182182
pull request.
183183

184+
### Building the Code
185+
186+
To make the code builds universal and canonical, I have a Docker configuration attached to this project
187+
which installs OpenJDK 8 on Ubuntu Xenial. This is the build environment I will be using to test and release
188+
the code.
189+
190+
```bash
191+
docker build -t spring-data-mock:jdk8 .
192+
docker run -it --rm -v $(pwd):/src spring-data-mock:jdk8
193+
```
194+
184195
Donation
185196
--------
186197

0 commit comments

Comments
 (0)