Skip to content

Commit 475e679

Browse files
committed
[CHA] Update README with references to changelog
There is no need to update releases in README file. Just make a reference on it to CHANGELOG or wiki.
1 parent 984aead commit 475e679

File tree

3 files changed

+33
-28
lines changed

3 files changed

+33
-28
lines changed

.travis.yml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ os: linux
33
dist: xenial
44
env:
55
global:
6-
- UNIT_TEST=true
7-
- MODELING_GAUSS=true
8-
- MODELING_MULTI=true
6+
- UNIT_TEST=false
7+
- MODELING_GAUSS=false
8+
- MODELING_MULTI=false
99
- DEPLOY=true
1010
git:
1111
depth: 1
@@ -29,13 +29,14 @@ jobs:
2929
name: Multi Layer
3030
- stage: Deploy
3131
name: Deploy
32-
if: env(DEPLOY)=true AND type = push AND branch = master
32+
if: env(DEPLOY)=true #AND type = push #AND branch = master
3333
script: echo "Deploy"
3434
before_deploy:
3535
- git config --local user.name "dirack"
3636
- git config --local user.email "[email protected]"
3737
- export TRAVIS_TAG=$(cat VERSION.md)
38-
- git tag $TRAVIS_TAG
38+
- ./deploy/build_tag_message.sh > tag.deploy
39+
- git tag -a $TRAVIS_TAG -F tag.deploy
3940
deploy:
4041
provider: releases
4142
token: $GITHUB_TOKEN
@@ -45,3 +46,4 @@ jobs:
4546
repo: Dirack/creGatherStack
4647
branch:
4748
- master
49+
- test

README.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
55
[Developed to Madagascar package, version 3.0.](http://www.ahay.org/wiki/Main_Page)
66

7-
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![Build Status](https://travis-ci.org/Dirack/creGatherStack.svg?branch=master)](https://travis-ci.org/Dirack/creGatherStack)
7+
[![Github release](https://img.shields.io/github/v/release/Dirack/creGatherStack)](https://github.com/Dirack/creGatherStack/releases/latest) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![Madagascar](https://img.shields.io/badge/Madagascar-v3.0-blue)](https://github.com/ahay/src/tree/master) [![Build Status](https://travis-ci.org/Dirack/creGatherStack.svg?branch=master)](https://travis-ci.org/Dirack/creGatherStack)
88

99
![Interpolated CRE Gather](https://github.com/Dirack/creGatherInterpolation/blob/master/images/hugeStackedSection.jpeg)
1010

@@ -96,30 +96,27 @@ _For more examples and details, please refer to the [Wiki](https://github.com/Di
9696
We also have many SConstruct examples in this repository in the
9797
[experiments directory](https://github.com/Dirack/creGatherStack/tree/master/experiments)
9898

99-
## Release History
99+
## Release History and Versions
100100

101-
* [v2.0](https://github.com/Dirack/creGatherStack/releases/tag/v2.0) - (Stable)
102-
103-
* [v1.0-beta.1](https://github.com/Dirack/creGatherStack/releases/tag/v1.0-beta.1) - (Beta)
104-
105-
* [v0.1.2-alpha.1](https://github.com/Dirack/creGatherStack/releases/tag/v0.1.2-alpha.1) - (Development)
106-
107-
[See the complete history decription in our wiki](https://github.com/Dirack/creGatherStack/wiki/Release-history)
101+
This package version is referenced in VERSION.md file, and you can see the [complete release history in our wiki](https://github.com/Dirack/creGatherStack/wiki/Release-history) or in the CHANGELOG.md file.
108102

109103
## Meta
110104

105+
[main page](https://github.com/Dirack/creGatherStack)
106+
111107
Rodolfo Dirack – [@dirack](https://github.com/Dirack)[email protected]
112108

113109
Distributed under the GPL3 license. See ``LICENSE`` for more information.
114110

115-
[creGatherStack main page](https://github.com/Dirack/creGatherStack)
116-
117111
## Contributing
118112

119-
1. Fork it (<https://github.com/Dirack/creGatherStack/fork>)
120-
2. Create your feature branch (`git checkout -b feature/fooBar`)
121-
3. Commit your changes (`git commit -am 'Add some fooBar'`)
122-
4. Push to the branch (`git push origin feature/fooBar`)
123-
5. Create a new Pull Request
113+
In order to contribute with this project you should follow the list of steps bellow, please check out ["How to contribute with this project?"](https://github.com/Dirack/creGatherStack/wiki/Contribute) in our Wiki for more details.
114+
115+
1. Create an issue to your request or choose an issue already defined
116+
2. Fork this project in https://github.com/Dirack/creGatherStack/fork
117+
3. Create a branch for your contribution (name it using gitflow)
118+
4. Do clear _commit_ messages (a title with 50 characters and two paragraphs of text)
119+
5. _Push_ your contribution to this repository
120+
6. Create a new Pull Request with a clear description of your contribution
124121

125-
###### Important contribution tip: The commit history should be clear, with commit mesages around one or two paraghraps describing your modifications. Pull Requests with unsatisfactory commit history will be rejected.
122+
###### Important: The commit history should be clear, with commit mesages around one or two paraghraps describing your modifications. Pull Requests with unsatisfactory commit history will be rejected.

deploy/build_tag_message.sh

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,16 @@ CURRENT_TAG=$(cat VERSION.md)
1414
echo "VERSION $CURRENT_TAG"
1515

1616
# TAG MESSAGE
17-
git log HEAD..."$PREVIOUS_TAG" --grep='\[ADD\]' --pretty='format:(%h) %s%n%b'
18-
git log HEAD..."$PREVIOUS_TAG" --grep='\[CHA\]' --pretty='format:(%h) %s%n%b'
19-
git log HEAD..."$PREVIOUS_TAG" --grep='\[DEP\]' --pretty='format:(%h) %s%n%b'
20-
git log HEAD..."$PREVIOUS_TAG" --grep='\[REM\]' --pretty='format:(%h) %s%n%b'
21-
git log HEAD..."$PREVIOUS_TAG" --grep='\[FIX\]' --pretty='format:(%h) %s%n%b'
22-
git log HEAD..."$PREVIOUS_TAG" --grep='\[SEC\]' --pretty='format:(%h) %s%n%b'
17+
echo "## Added"
18+
git log HEAD..."$PREVIOUS_TAG" --grep='^\[ADD\]' --pretty='format:(%h) %s%n%b%n'
19+
echo "## Changed"
20+
git log HEAD..."$PREVIOUS_TAG" --grep='^\[CHA\]' --pretty='format:(%h) %s%n%b%n'
21+
echo "## Deprecated"
22+
git log HEAD..."$PREVIOUS_TAG" --grep='^\[DEP\]' --pretty='format:(%h) %s%n%b%n'
23+
echo "## Removed"
24+
git log HEAD..."$PREVIOUS_TAG" --grep='^\[REM\]' --pretty='format:(%h) %s%n%b%n'
25+
echo "## Fixed"
26+
git log HEAD..."$PREVIOUS_TAG" --grep='^\[FIX\]' --pretty='format:(%h) %s%n%b%n'
27+
echo "## Security"
28+
git log HEAD..."$PREVIOUS_TAG" --grep='^\[SEC\]' --pretty='format:(%h) %s%n%b%n'
2329

0 commit comments

Comments
 (0)