@@ -85,6 +85,12 @@ forget to document your changes in CHANGELOG.md.
85
85
86
86
# How to release a new version of Oxidized-web?
87
87
88
+ ## Version numbering
89
+ Oxidized-web versions are numbered like major.minor.patch
90
+ - currently, the major version is 0.
91
+ - minor is incremented when releasing new features.
92
+ - patch is incremented when releasing fixes only.
93
+
88
94
## Review changes
89
95
Run ` git diff 0.xx.yy..master ` (where ` 0.xx.yy ` is to be changed to the last
90
96
release) and review all the changes that have been done. Have a specific look
@@ -100,73 +106,72 @@ bundle update
100
106
bundle outaded
101
107
```
102
108
103
- Retest after updating!
109
+ Test again after updating!
104
110
105
111
## Update the weblibs to the latest versions
106
112
```
107
113
npm outdated
108
114
```
109
115
110
- Retest after updating!
111
-
112
- ## Update rubocup .rubocop_todo.yml
113
- Run ` bundle exec rubocop --auto-gen-config ` ,
114
- and make sure ` bundle exec rake ` passes after it.
115
-
116
- If you change some code => Restart the release process at the beginning ;-)
116
+ Test again after updating!
117
117
118
118
## Make sure the file permissions are correct
119
119
Run ` bundle exec rake chmod `
120
120
121
- ## Test, test test!
122
- Run ` bundle exec rake ` on the git repository to check the code against rubocop and rund the
123
- defined tests in ` /spec ` .
121
+ ## Create a release branch
122
+ Name the release branch ` release/0.xx.yy `
124
123
125
- Run Oxidized-web from git against the latest Oxidized version ` bundle exec oxdized `
124
+ Update CHANGELOG.md:
125
+ - review it
126
+ - add release notes
127
+ - set the new version (replace ` [Unreleased] ` with ` [0.xx.yy – 202Y-MM-DD] ` )
128
+
129
+ Change the version in ` lib/oxidized/web/version.rb `
126
130
127
- Run Oxidized-web from git against the latest git of Oxidized (see above) .
131
+ Upload the branch to github, make a Pull Request for it .
128
132
129
- Do not integrate late PRs into master if they do not fix issues for the release. The must wait for the next release.
133
+ ## Test!
134
+ Run ` bundle exec rake ` on the git repository to check the code against rubocop
135
+ and run the defined tests in ` /spec ` .
136
+
137
+ Run Oxidized-web from git against the latest Oxidized version ` bundle exec oxdized `
130
138
131
139
When testing the web application, open the javascript console in the browser to
132
140
see any errors.
133
141
134
- ## Version numbering
135
- Oxidized-web versions are nummered like major.minor.patch
136
- - currently, the major version is 0.
137
- - minor is incremented when releasing new features.
138
- - patch is incremented when releasing fixes only.
139
-
140
142
## Release
141
- 1 . Checkout the master branch of oxidized-web. Make sure you are up to date with origin.
142
- 2 . Change the version in lib/oxidized/web/version.rb
143
- 3 . Change CHANGELOG.md to replace [ Unreleased] with [ 0.xx.yy – 202Y-MM-DD]
144
- 4 . Run ` git diff ` to check your changes
145
- 5 . Commit the changes to the local git repository with a commit message “chore(release): release version 0.xx.yy”
146
- 6 . Tag the commit with ` git tag -a 0.xx.yy -m "Release 0.xx.yy" `
147
- 7 . Build the gem with ‘rake build’
148
- 8 . Install an test the gem locally:
149
- ```
143
+ 1 . Merge the Pull Request into master with the commit message
144
+ ` chore(release): release version 0.3x.y `
145
+ 2 . ` git pull ` master
146
+ 3 . Tag the commit with ` git tag -a 0.xx.yy -m "Release 0.xx.yy" `
147
+ 4 . Build the gem with ‘rake build’
148
+ 5 . Run ` git diff ` to check if there have been more changes (there shouldn't)
149
+ 6 . Install an test the gem locally
150
+ ``` shell
150
151
gem install --user-install pkg/oxidized-web-0.xx.yy.gem
151
152
~ /.local/share/gem/ruby/3.1.0/bin/oxidized
152
153
```
154
+
153
155
## Release in github
154
- 1 . Push the commit and the tag to github:
156
+ Push the tag to github:
155
157
```
156
- git push
157
158
git push origin 0.xx.yy
158
159
```
159
160
160
- 2 . Make a release from the tag in github
161
- - Thank the contributors
162
- - Only describe major changes, and refer to CHANGELOG.md
161
+ Make a release from the tag in github.
162
+ - Take the release notes frm CHANGELOG.md
163
163
- List new contributors (generated automatically)
164
+ - Keep the Full Changelog (generated automatically)
164
165
165
166
## Release in rubygems
166
167
Push the gem with ‘rake push’
167
168
168
169
You need an account at rubygems which is allowed to push oxidized
169
170
171
+ ## Release in docker.io
172
+ In order to release in docker.io, oxidized be released to a new version,
173
+ as the container is build there.
174
+
170
175
## Update CHANGELOG.md for next release
171
176
Add
172
177
```
181
186
```
182
187
And push to github
183
188
184
- ## Congratulate yourself
185
- Great job! Treat yourself to your favorite drink, you deserve it!
186
-
0 commit comments