Skip to content

Commit 0dc1f9c

Browse files
croakygeoffharcourt
authored andcommitted
Update release documentation for contributors
We are not using Traveling Ruby since ea23f26. Describe the new process!
1 parent 54633b2 commit 0dc1f9c

File tree

1 file changed

+12
-30
lines changed

1 file changed

+12
-30
lines changed

RELEASING.md

Lines changed: 12 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,20 @@
11
Releasing
22
=========
33

4-
Parity uses a set of `rake` tasks to create packages and bundles [traveling
5-
ruby][traveling_ruby] to simplify the dependency on Ruby.
6-
7-
Generating packages
8-
-------------------
9-
10-
Packages can be generated for the following systems:
11-
12-
* OSX `rake package:osx`
13-
* Linux x86 `rake package:linux:x86`
14-
* Linux x86_64 `rake package:linux:x86_64`
15-
16-
You can generate all packages with `rake package:all`
17-
18-
[traveling_ruby]: https://github.com/phusion/traveling-ruby
19-
20-
The packages generated are tarballs of the following directory structure:
21-
22-
parity-package
23-
├── bin # shims
24-
└── lib
25-
├── app # parity's bin and lib directories
26-
└── ruby # traveling ruby for target system
27-
28-
Releasing a new version
29-
-----------------------
30-
314
1. Update the version in `lib/parity/version.rb`
325
1. Create a new tag based on the version number
33-
1. Generate packages
34-
1. Create a [release] for the latest tag and attach the packages
35-
1. Update the [homebrew formula] to point to the latest OSX package
6+
1. Create a GitHub [release] for the latest tag
7+
1. Update the [homebrew formula] to point to the latest GitHub release. Include
8+
the path and the SHA.
9+
10+
Development Releases
11+
====================
12+
13+
Update the [development release] on the repository page, uploading a tarred,
14+
gzipped collection of files. The Homebrew formula does not require a SHA for a
15+
development build, and will always point to the file if the name remains
16+
consistent.
3617

3718
[homebrew formula]: https://github.com/thoughtbot/homebrew-formulae/blob/master/Formula/parity.rb
3819
[release]: https://github.com/thoughtbot/parity/releases
20+
[development release]: https://github.com/thoughtbot/parity/releases/tag/development

0 commit comments

Comments
 (0)