Skip to content

Commit

Permalink
fixed #12 - Added documentation for releasing a new version
Browse files Browse the repository at this point in the history
  • Loading branch information
dzc34 committed Apr 22, 2017
1 parent 0474088 commit d0e25b1
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 1 deletion.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Configuration:

Documentation:
- [#42 - Fixed Javadoc warnings](https://github.com/Asqatasun/Contrast-Finder/issues/42)
- [#12 - Added documentation for releasing a new version](https://github.com/Asqatasun/Contrast-Finder/issues/12)

Upgrade-o-meter:
none
Expand Down
58 changes: 57 additions & 1 deletion documentation/en/30_Contributor_doc/Release/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,63 @@ This is the documentation for releasing a new version for Contrast-Finder.
As an end user, you won't need it, it is just for developers.

## The process
@@@TODO

### check dependencies, compile and test it
```bash
# check dependencies (security)
mvn dependency-check:aggregate

# compile and test it
docker/compile_and_build_docker_image.sh -l -s ${PWD} -d docker/SNAPSHOT-local_from-Ubuntu

```

outdated dependencies:
https://www.versioneye.com/user/projects/58fb3e17c2ef423822580804?child=summary#tab-dependencies

### Prepare a Release
```bash
# change version ("x.y.z-dev" to "x.y.z")
# + commit
# */pom.xml
# */Dockerfile
# CHANGELOG
# Docker/REALESE/README
# (...)/template_variables.jspf
git checkout develop
(...)
git add .
git commit -m "set version to x.y.z"

# Merge and commit
git checkout master
git merge --no-ff --log develop
```

Plugin to do some of the work
http://maven.apache.org/maven-release/maven-release-plugin/index.html

### Test it
```bash
# compile and test it
docker/compile_and_build_docker_image.sh -l -s ${PWD} -d docker/SNAPSHOT-local_from-Ubuntu
```

### Release
```bash
# add tag
# push tag
# push master

# upload tar.gz (github)
# docker hub : manage new build
# check docker build
docker pull asqatasun/contrast-finder
docker run -d -p 8080:8080 asqatasun/contrast-finder

# docker hub : manage new build for asqatasun/asqa.mvn:contrast.finder_jdk*
```


## Versioning

Expand Down

0 comments on commit d0e25b1

Please sign in to comment.