Skip to content

Commit fac0286

Browse files
committed
Merge branch 'release/v0.18.0'
2 parents 862fd19 + 34edfb3 commit fac0286

38 files changed

+690
-600
lines changed

.codecov.yml

Lines changed: 0 additions & 1 deletion
This file was deleted.

.travis.yml

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ language: julia
2424

2525
matrix:
2626
allow_failures:
27-
- julia: nightly
27+
- julia: nightly
28+
fast_finish: true
2829

2930
notifications:
3031
email:
@@ -69,11 +70,6 @@ after_success:
6970
- julia --check-bounds=yes --color=yes -e 'Pkg.add("Coverage");'
7071
- julia --check-bounds=yes --color=yes -e 'cd(Pkg.dir("PredictMD"));
7172
using Coverage; Codecov.submit(Codecov.process_folder());'
72-
- if [[ "$TRAVIS_OS_NAME" == "linux" ]];
73-
then julia --check-bounds=yes --color=yes -e '
74-
cd(Pkg.dir("PredictMD"));
75-
using Coverage;
76-
Coveralls.submit(Coveralls.process_folder());'; fi
7773
- julia --check-bounds=yes --color=yes -e '
7874
cd(Pkg.dir("PredictMD"));
7975
include(joinpath("docs", "deploy_docs.jl"))'

CONTRIBUTING.md

Lines changed: 115 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -44,18 +44,21 @@ You also need to have the following tools installed and configured:
4444

4545
### 1.1 GitHub account
4646

47-
**Step 1:** If you already have a GitHub account, go to
47+
#### Step 1:
48+
If you already have a GitHub account, go to
4849
[https://github.com/login](https://github.com/login) and log in.
4950
If you do not already have a GitHub account, go to
5051
[https://github.com/join](https://github.com/join) and create an account.
5152

52-
**Step 2:** Go to [https://help.github.com/articles/configuring-two-factor-authentication-via-a-totp-mobile-app/](https://help.github.com/articles/configuring-two-factor-authentication-via-a-totp-mobile-app/)
53+
#### Step 2:
54+
Go to [https://help.github.com/articles/configuring-two-factor-authentication-via-a-totp-mobile-app/](https://help.github.com/articles/configuring-two-factor-authentication-via-a-totp-mobile-app/)
5355
and follow the instructions to enable two-factor
5456
authentication for your GitHub account.
5557

5658
### 1.2 git
5759

58-
**Step 1:** Open a terminal window and run the following command:
60+
#### Step 1:
61+
Open a terminal window and run the following command:
5962
```bash
6063
git --version
6164
```
@@ -72,23 +75,24 @@ download and install Git:
7275
- macOS: [https://git-scm.com/download/mac](https://git-scm.com/download/mac)
7376
- GNU/Linux: [https://git-scm.com/download/linux](https://git-scm.com/download/linux)
7477

75-
**Step 2:**
78+
#### Step 2:
7679
```bash
7780
git config --global user.name "Myfirstname Mylastname"
7881
```
7982

80-
**Step 3:**
83+
#### Step 3:
8184
```bash
8285
git config user.email "myemailaddress@example.com"
8386
```
8487

85-
**Step 4:**
88+
#### Step 4:
8689

8790
```bash
8891
git config --global github.user mygithubusername
8992
```
9093

91-
**Step 5:** Follow the steps on each of the following pages in order to
94+
#### Step 5:
95+
Follow the steps on each of the following pages in order to
9296
generate an SSH key and associate it with your GitHub account:
9397
1. [https://help.github.com/articles/checking-for-existing-ssh-keys/](https://help.github.com/articles/checking-for-existing-ssh-keys/)
9498
2. [https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/)
@@ -98,7 +102,8 @@ generate an SSH key and associate it with your GitHub account:
98102

99103
### 1.3 git-flow
100104

101-
**Step 1:** Open a terminal window and run the following command:
105+
#### Step 1:
106+
Open a terminal window and run the following command:
102107
```bash
103108
git flow
104109
```
@@ -128,7 +133,8 @@ install git-flow:
128133

129134
### 1.4 GPG
130135

131-
**Step 1:** Open a terminal window and run the following command:
136+
#### Step 1:
137+
Open a terminal window and run the following command:
132138
```bash
133139
gpg --version
134140
```
@@ -156,7 +162,8 @@ download and install GPG:
156162
- macOS: [https://gpgtools.org/](https://gpgtools.org/)
157163
- GNU/Linux: [https://gnupg.org/download/#sec-1-2](https://gnupg.org/download/#sec-1-2)
158164

159-
**Step 2:** Follow the steps on each of the following pages in order to
165+
#### Step 2:
166+
Follow the steps on each of the following pages in order to
160167
generate a GPG key and associate it with your GitHub account:
161168
1. [https://help.github.com/articles/checking-for-existing-gpg-keys/](https://help.github.com/articles/checking-for-existing-gpg-keys/)
162169
2. [https://help.github.com/articles/generating-a-new-gpg-key/](https://help.github.com/articles/generating-a-new-gpg-key/)
@@ -166,20 +173,24 @@ generate a GPG key and associate it with your GitHub account:
166173

167174
## 2. Setting up the PredictMD repo
168175

169-
**Step 1:** Make sure that you have followed all of the instructions
176+
#### Step 1:
177+
Make sure that you have followed all of the instructions
170178
in [Section 1 (Prerequisites)](#1-prerequisites).
171179

172-
**Step 2:** Follow the installation instructions in
180+
#### Step 2:
181+
Follow the installation instructions in
173182
[README.md](README.md) to install PredictMD.
174183

175-
**Step 3:** Open a terminal window and `cd` to the directory
184+
#### Step 3:
185+
Open a terminal window and `cd` to the directory
176186
containing the PredictMD source code:
177187

178188
```bash
179189
cd ~/.julia/v0.6/PredictMD
180190
```
181191

182-
**Step 4:** Run the following lines:
192+
#### Step 4:
193+
Run the following lines:
183194

184195
```bash
185196
git config commit.gpgsign true &&
@@ -200,32 +211,36 @@ git fetch --all --prune
200211
your GPG set-up is working.
201212
Release tags MUST be signed with your GPG key.**
202213

203-
**Step 1:** Open a terminal window and `cd` to the directory
204-
containing the PredictMD source code:
214+
#### Step 1:
215+
Open a terminal window and `cd` to the directory containing the PredictMD source code:
205216

206217
```bash
207218
cd ~/.julia/v0.6/PredictMD
208219
```
209220

210-
**Step 2:** Fetch the latest versions of all branches:
221+
#### Step 2:
222+
Fetch the latest versions of all branches:
211223

212224
```bash
213225
git fetch --all --prune
214226
```
215227

216-
**Step 3:** Checkout the `develop` branch:
228+
#### Step 3:
229+
Checkout the `develop` branch:
217230

218231
```bash
219232
git checkout develop
220233
```
221234

222-
**Step 4:** Pull the latest version of `develop`.
235+
#### Step 4:
236+
Pull the latest version of `develop`.
223237

224238
```bash
225239
git pull
226240
```
227241

228-
**Step 5:** Determine the version number that you are going to
242+
#### Step 5:
243+
Determine the version number that you are going to
229244
release. We use the Semantic Versioning
230245
system: [https://semver.org](https://semver.org). In Semantic
231246
Versioning, version numbers take the form `vMAJOR.MINOR.PATCH`.
@@ -240,7 +255,8 @@ is `v3.5.12` and that we are adding functionality in a
240255
backwards-compatible manner. So we increment the `MINOR` version,
241256
which means the new version that we are tagging is `v3.6.0`.
242257

243-
**Step 6:** Start a new release branch.
258+
#### Step 6:
259+
Start a new release branch.
244260

245261
```bash
246262
git flow release start v3.6.0
@@ -252,7 +268,8 @@ git flow release start v3.6.0
252268
you can list all of the release branches by running the following
253269
command:* `git flow release list`
254270

255-
**Step 7:** Open the source file `src/base/version.jl` and change
271+
#### Step 7:
272+
Open the source file `src/base/version.jl` and change
256273
the version number. For example, if the file looks like this:
257274

258275
```julia
@@ -275,7 +292,8 @@ catch e
275292
end
276293
```
277294

278-
**Step 8:** Commit your changes:
295+
#### Step 8:
296+
Commit your changes:
279297

280298
```bash
281299
git add src/base/version.jl
@@ -286,13 +304,15 @@ An commit message editor will open. Type an appropriate commit
286304
message (e.g. "Bump version number"), save the file, and quit the
287305
editor.
288306

289-
**Step 9:** Push the release branch to GitHub.
307+
#### Step 9:
308+
Push the release branch to GitHub.
290309

291310
```bash
292311
git push origin release/v3.6.0
293312
```
294313

295-
**Step 10:** Wait for all of the tests to pass. You can check on
314+
#### Step 10:
315+
Wait for all of the tests to pass. You can check on
296316
the status of the tests by going to
297317
[https://github.com/bcbi/PredictMD.jl/branches/yours](https://github.com/bcbi/PredictMD.jl/branches/yours)
298318
and scrolling down to find your release branch.
@@ -310,7 +330,8 @@ you can continue.**
310330
This is especially common with the Mac builds on Travis. You can usually
311331
resolve this error by restarting the failed build.*
312332

313-
**Step 11:** Once all of the Travis tests have passed, you can finish
333+
#### Step 11:
334+
Once all of the tests have passed, you can finish
314335
tagging your release using the git-flow tools:
315336

316337

@@ -332,7 +353,8 @@ the file, and close the editor.
332353
Once you have finished all of the commits and tags, you must verify
333354
that you have correctly signed the release tag:
334355

335-
**Step 12:** Verify that you have correctly signed the release tag:
356+
#### Step 12:
357+
Verify that you have correctly signed the release tag:
336358
```bash
337359
git tag -v v3.6.0
338360
```
@@ -352,7 +374,8 @@ point, you should
352374
and mention [@DilumAluthge](https://github.com/DilumAluthge) in the
353375
issue body.
354376

355-
**Step 13:** Temporarily modify the branch protections for
377+
#### Step 13:
378+
Temporarily modify the branch protections for
356379
the `master` and `develop` branches:
357380

358381
First, the `master` branch: go to
@@ -366,15 +389,17 @@ Now do the same thing for the `develop` branch: Go to
366389
scroll down, UNCHECK the box next to "Include administrators", scroll to
367390
the bottom of the page, and click the green "Save changes" button.
368391

369-
**Step 14:** Push the new release to GitHub:
392+
#### Step 14:
393+
Push the new release to GitHub:
370394

371395
```bash
372396
git push origin master # push the updated "master" branch
373397
git push origin develop # push the updated "develop" branch
374398
git push origin --tags # push the new "v3.6.0" tag
375399
```
376400

377-
**Step 15:** Create a release on GitHub using the tag you just
401+
#### Step 15:
402+
Create a release on GitHub using the tag you just
378403
created, signed, and pushed. First, go to
379404
[https://github.com/bcbi/PredictMD.jl/releases/new](https://github.com/bcbi/PredictMD.jl/releases/new).
380405
In the text box that reads "Tag version", type the name of the tag you
@@ -383,7 +408,8 @@ text box that reads "Release title", type an appropriate title, such
383408
as "PredictMD version 3.6.0". Finally, click the green
384409
"Publish release" button.
385410

386-
**Step 16:** Update the version number in the `develop` branch:
411+
#### Step 16:
412+
Update the version number in the `develop` branch:
387413

388414
First, use Semantic Versioning ([https://semver.org](https://semver.org))
389415
determine what the next version number will be. In our example, we have
@@ -429,7 +455,8 @@ catch e
429455
end
430456
```
431457

432-
**Step 17:** Commit your changes:
458+
#### Step 17:
459+
Commit your changes:
433460

434461
```bash
435462
git add src/base/version.jl
@@ -440,12 +467,14 @@ An commit message editor will open. Type an appropriate commit
440467
message (e.g. "Bump version number"), save the file, and quit
441468
the editor.
442469

443-
**Step 18:** Push the updated develop branch:
470+
#### Step 18:
471+
Push the updated develop branch:
444472
```bash
445473
git push origin develop
446474
```
447475

448-
**Step 19:** Re-enable the branch protection settings:
476+
#### Step 19:
477+
Re-enable the branch protection settings:
449478

450479
`master` branch: go to
451480
[https://github.com/bcbi/PredictMD.jl/settings/branches/master](https://github.com/bcbi/PredictMD.jl/settings/branches/master),
@@ -459,10 +488,60 @@ scroll down, CHECK the box next to "Include administrators", scroll to
459488
the bottom of the page, and click the green
460489
"Save changes" button.
461490

462-
**Step 20:** Delete the release branch, which is no longer needed. To do
491+
#### Step 20:
492+
Delete the release branch, which is no longer needed. To do
463493
this, go to
464494
[https://github.com/bcbi/PredictMD.jl/branches/yours](https://github.com/bcbi/PredictMD.jl/branches/yours),
465495
scroll down to find the release branch, and then click the
466496
trash can icon to delete the branch.
467497

468-
Congratulations, you are finished!
498+
#### Step 21:
499+
The final step is to go to the Zenodo entry for the newly created release and put in the correct information. First go to [https://www.predictmd.net/zenodo](https://www.predictmd.net/zenodo), and then click on the yellow "Edit" button to edit the most recent release. Then, fill out the following fields with the specified values:
500+
501+
##### Upload type:
502+
* Software
503+
504+
##### Basic information -> Title:
505+
* PredictMD - Uniform interface for machine learning in Julia
506+
507+
##### Basic information -> Authors:
508+
509+
| Name | Affiliation | ORCID |
510+
| ---- | ----------- | ----- |
511+
| Aluthge DP | Brown Center for Biomedical Informatics, Brown University | 0000-0002-9247-0530 |
512+
| Sinha I | Brown Center for Biomedical Informatics, Brown University | |
513+
| Stey P | Brown Center for Biomedical Informatics, Brown University | |
514+
| Restrepo MI | Brown Center for Biomedical Informatics, Brown University | 0000-0002-2708-8984 |
515+
| Chen ES | Brown Center for Biomedical Informatics, Brown University | 0000-0002-6181-3369 |
516+
| Sarkar IN | Brown Center for Biomedical Informatics, Brown University | 0000-0003-2054-7356 |
517+
518+
##### Basic information -> Description:
519+
* PredictMD is a free and open-source Julia package that provides a uniform interface for machine learning.
520+
521+
##### Basic information -> Language:
522+
* English
523+
524+
##### Basic information -> Keywords:
525+
* biomedical informatics
526+
* Julia
527+
* machine learning
528+
* statistics
529+
530+
##### Basic information -> Additional notes:
531+
* Development of PredictMD was supported in part by National Institutes of Health grants U54GM115677, R01LM011963, and R25MH116440. The content is solely the responsibility of the authors and does not necessarily represent the official views of the National Institutes of Health.
532+
533+
##### License -> License:
534+
* MIT License
535+
536+
##### Related/alternate identifiers -> Related identifiers:
537+
538+
(Replace `vMAJOR.MINOR.PATCH` with the appropriate version number. In our example, you would replace `vMAJOR.MINOR.PATCH` with `v3.6.0`.)
539+
540+
| Identifier | Relationship |
541+
| ----- | ----- |
542+
| `https://www.predictmd.net` | compiled/created this upload |
543+
| `https://www.predictmd.net/vMAJOR.MINOR.PATCH` | documents this upload |
544+
| `https://github.com/bcbi/PredictMD.jl/releases/tag/vMAJOR.MINOR.PATCH` | is an alternate identifier of this upload |
545+
| `https://github.com/bcbi/PredictMD.jl/tree/vMAJOR.MINOR.PATCH` | is an alternate identifier of this upload |
546+
547+
After you have entered the correct information in all of the above fields, click the white "Save" button, and then click the blue "Publish" button. Congratulations, you are finished!

README.md

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -86,21 +86,6 @@ PredictMD's internals.
8686
<img alt="CodeCov (develop)" title="CodeCov (develop)" src="https://codecov.io/gh/bcbi/PredictMD.jl/branch/develop/graph/badge.svg"
8787
/></a></td>
8888
</tr>
89-
<tr>
90-
<td>Coveralls</td>
91-
<td>
92-
<a
93-
href="https://coveralls.io/github/bcbi/PredictMD.jl?branch=master">
94-
<img alt="Coverage status (master)"
95-
title="Coverage status (master)"
96-
src="https://coveralls.io/repos/github/bcbi/PredictMD.jl/badge.svg?branch=master"
97-
/></a></td>
98-
<td>
99-
<a
100-
href="https://coveralls.io/github/bcbi/PredictMD.jl?branch=develop">
101-
<img alt="Coverage status (develop)" title="Coverage status (develop)" src="https://coveralls.io/repos/github/bcbi/PredictMD.jl/badge.svg?branch=develop"
102-
/></a></td>
103-
</tr>
10489
<tr>
10590
<td>docs</td>
10691
<td><a href="https://www.predictmd.net/stable">

0 commit comments

Comments
 (0)