Skip to content

Commit 910a48d

Browse files
authored
Merge pull request #158 from web-animations/fix-release-instructions
Fix release instructions
2 parents 4637cef + c6f0ac8 commit 910a48d

File tree

1 file changed

+24
-7
lines changed

1 file changed

+24
-7
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,14 @@ Example: `http://localhost:9876/base/test/web-platform-tests/web-animations/anim
4545

4646
## Publishing a release
4747

48+
1. Clone a fresh copy of [web-animations-js](https://github.com/web-animations/web-animations-js).
49+
50+
1. Make sure you are on the `dev` branch.
51+
52+
```sh
53+
git checkout dev
54+
```
55+
4856
1. Determine the version number for the release
4957

5058
* Increment the first number and reset others to 0 when there are large breaking changes
@@ -70,8 +78,14 @@ Example: `http://localhost:9876/base/test/web-platform-tests/web-animations/anim
7078

7179
1. Build the polyfill with `npm install && grunt` then update `docs/experimental.md`'s Build Target Comparison with the current gzipped sizes.
7280
73-
1. Commit the above changes to web-animations-js/dev and merge to
74-
web-animations-js/master.
81+
1. Commit and push the above changes to web-animations-js/dev.
82+
83+
```sh
84+
# Create a commit with above changes
85+
git push origin dev
86+
```
87+
88+
1. Merge to local master branch:
7589
7690
```sh
7791
git checkout master
@@ -85,14 +99,17 @@ Example: `http://localhost:9876/base/test/web-platform-tests/web-animations/anim
8599
grunt
86100
# Optional "grunt test" to make sure everything still passes.
87101
git add -f *.min.js{,.map}
88-
git rm .gitignore
102+
git rm --ignore-unmatch .gitignore
89103
git commit -m 'Add build artifacts from '`cat .git/refs/heads/dev`
90-
git push HEAD:refs/heads/master
104+
git push origin master
91105
```
92106
93-
1. Draft a [new release](https://github.com/web-animations/web-animations-js/releases) at the
94-
commit pushed to web-animations-js in step #4. Copy the release notes from `History.md`
95-
added in step #2.
107+
1. Draft a [new release](https://github.com/web-animations/web-animations-js/releases).
108+
109+
* For the **tag version**, put the new version number of this release.
110+
* For the **target**, select "master".
111+
* For the **title**, look at previous releases for examples.
112+
* For the **description**, copy the release notes from `History.md` added in step #2.
96113
97114
1. Once you've pushed to web-animations-js, run `npm publish` from that checked-out folder
98115

0 commit comments

Comments
 (0)