|
a |
|
b/src/worker/src/node_modules/coffeelint/doc/release.md |
|
|
1 |
Release Steps
|
|
|
2 |
=============
|
|
|
3 |
|
|
|
4 |
1. Review changelog
|
|
|
5 |
-------------------
|
|
|
6 |
|
|
|
7 |
I always use the top changelog link on [coffeelint.org][changelog] and change it
|
|
|
8 |
to point to `compare/vx.x.x...master`. Look through the pull request to figure
|
|
|
9 |
out whether this is a minor or patch release.
|
|
|
10 |
|
|
|
11 |
2. Tag
|
|
|
12 |
------
|
|
|
13 |
|
|
|
14 |
CoffeeLint follows [semver](http://semver.org/). When a new rule is added even
|
|
|
15 |
if it's off by default, it's at least a minor release. There are some things
|
|
|
16 |
marked deprecated. If we ever have a need for a 2.0 I'll remove those at that
|
|
|
17 |
time.
|
|
|
18 |
|
|
|
19 |
npm version <major|minor|patch>
|
|
|
20 |
|
|
|
21 |
3. Write changelog
|
|
|
22 |
------------------
|
|
|
23 |
|
|
|
24 |
git checkout gh-pages
|
|
|
25 |
|
|
|
26 |
The changelog is in `index-bottom.html`. Update it based on the PRs found in
|
|
|
27 |
step 1. I don't always mention every PR. Many internal changes like updates to
|
|
|
28 |
Travis don't matter to users of CoffeeLint, so I leave them out.
|
|
|
29 |
|
|
|
30 |
This next step is going to end up checkout out master, so I'll usually commit
|
|
|
31 |
the changelog updates and then I'll run `git commit --amend` after the next step.
|
|
|
32 |
|
|
|
33 |
4. Update `gh-page`'s coffeelint
|
|
|
34 |
--------------------------------
|
|
|
35 |
|
|
|
36 |
rake update
|
|
|
37 |
|
|
|
38 |
I've never rewritten how this gets generated. Because it needs to pull a
|
|
|
39 |
compiled version of CoffeeLint from master, `rake update` gives you a set of
|
|
|
40 |
commands to copy and paste.
|
|
|
41 |
|
|
|
42 |
# It doesn't matter if you ammend or add a new commit, this is just what I do.
|
|
|
43 |
git commit --amend
|
|
|
44 |
|
|
|
45 |
5. Release all the things!
|
|
|
46 |
--------------------------
|
|
|
47 |
|
|
|
48 |
git checkout master
|
|
|
49 |
git push origin master
|
|
|
50 |
git push origin gh-pages
|
|
|
51 |
git push origin <tag>
|
|
|
52 |
|
|
|
53 |
I think it's important that people be able to install CoffeeLint directly from
|
|
|
54 |
git. People also got upset when the NPM version required installing browserify
|
|
|
55 |
and coffeeify when they were never actually used. For this reason I have a
|
|
|
56 |
`prepublish` script that will yank those and the `install` script out of
|
|
|
57 |
`package.json`. I had this fail to run for me once, so now I run it manually
|
|
|
58 |
just to make sure it's fine before I publish.
|
|
|
59 |
|
|
|
60 |
npm run prepublish
|
|
|
61 |
git diff
|
|
|
62 |
npm publish
|
|
|
63 |
git checkout package.json
|
|
|
64 |
|
|
|
65 |
[changelog]: http://www.coffeelint.org/#changelog
|
|
|
66 |
[review]: https://github.com/clutchski/coffeelint/compare/v1.8.1...master
|