Skip to content

Commit d302ac8

Browse files
committed
chore: add RELEASING
1 parent e183365 commit d302ac8

File tree

1 file changed

+70
-0
lines changed

1 file changed

+70
-0
lines changed

RELEASING.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Releasing
2+
3+
This guide explains how to release a new version of the uptrace-ruby gem to
4+
RubyGems.
5+
6+
## Managing Dependencies
7+
8+
### Checking for outdated dependencies
9+
10+
To view outdated dependencies:
11+
12+
```shell
13+
bundle outdated
14+
```
15+
16+
### Updating dependencies
17+
18+
Edit the `Gemfile` to update dependency versions, then update the
19+
`Gemfile.lock`:
20+
21+
```shell
22+
bundle update
23+
```
24+
25+
### Installing dependencies
26+
27+
To install all dependencies:
28+
29+
```shell
30+
bundle install
31+
```
32+
33+
## Running Tests
34+
35+
Before releasing, ensure all tests pass:
36+
37+
```shell
38+
rake test
39+
```
40+
41+
## Running linter
42+
43+
To run linter:
44+
45+
```shell
46+
bundle exec rake
47+
```
48+
49+
To auto-correct issues:
50+
51+
```shell
52+
bundle exec rubocop -A
53+
```
54+
55+
## Publishing a Release
56+
57+
1. **Update the version**: Bump the version number in `lib/uptrace/version.rb`
58+
59+
2. **Build and publish the gem**:
60+
61+
```shell
62+
gem build uptrace.gemspec
63+
bundle install
64+
gem push uptrace-X.Y.Z.gem
65+
```
66+
67+
Replace `X.Y.Z` with the actual version number you specified in step 1.
68+
69+
**Note**: Make sure you have the necessary permissions to push to the uptrace
70+
gem on RubyGems before attempting to publish.

0 commit comments

Comments
 (0)