Skip to content

Commit 154b21d

Browse files
committed
Add CONTRIBUTING.md with release process
1 parent 9f29e68 commit 154b21d

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

CONTRIBUTING.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Contribution notes
2+
3+
## Release process
4+
5+
* Make sure `CHANGELOG.md` is up to date (add the release date) and the build is green.
6+
* If this is the first release for this minor version, create a new branch for it:
7+
```
8+
$ git checkout -b releases/1.7.x
9+
```
10+
* Update the hardcoded `SentryBundle::VERSION` constant:
11+
```
12+
class SentryBundle extends Bundle
13+
{
14+
const VERSION = '1.7.0';
15+
}
16+
```
17+
* Commit the changes:
18+
```
19+
$ git commit -am "Release 1.7.0"
20+
```
21+
* Tag the new commit:
22+
```
23+
git tag 1.7.0
24+
```
25+
* Push the tag:
26+
```
27+
git push --tags
28+
```
29+
* Switch back to `master`:
30+
```
31+
git checkout master
32+
```
33+
* Add the next minor release to the `CHANGES` file:
34+
```
35+
## 1.8.0 (unreleased)
36+
```
37+
* Update the hardcoded `SentryBundle::VERSION` constant:
38+
```
39+
class Raven_Client
40+
{
41+
const VERSION = '1.8.x-dev';
42+
}
43+
```
44+
* Lastly, update the composer version in ``composer.json``:
45+
46+
```
47+
"extra": {
48+
"branch-alias": {
49+
"dev-master": "1.8.x-dev"
50+
}
51+
}
52+
```
53+
* Commit the changes:
54+
```
55+
$ git commit -am "Cleanup after release 1.7"
56+
```
57+
58+
All done! Composer will pick up the tag and configuration automatically.

0 commit comments

Comments
 (0)