Skip to content

Commit 52d751a

Browse files
authored
Merge pull request #541 from scala-js/topic/releasing
Document release process
2 parents 129d5d4 + 7899e1f commit 52d751a

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

RELEASING.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
How to Perform a Release
2+
========================
3+
4+
1. The first step is to create a tag, push it, and let GitHub Actions do the release.
5+
6+
```sh
7+
# For v1.x.y
8+
ver=1.2.0 # change this to new version
9+
git checkout series/1.x
10+
git checkout -b topic/v$ver
11+
echo "ThisBuild / version := \"$ver\" // Workaround for #504" > version.sbt
12+
git add version.sbt
13+
git commit -m "Setting version to v$ver"
14+
git tag -s v$ver
15+
git push --tags
16+
17+
# For v2.x onwards
18+
ver=2.0.0 # change this to new version
19+
git checkout master
20+
git tag -s v$ver
21+
git push --tags
22+
```
23+
24+
25+
2. Wait for the release to complete.
26+
https://github.com/scala-js/scala-js-dom/actions/workflows/release.yml
27+
28+
3. Go to GitHub releases (https://github.com/scala-js/scala-js-dom/releases),
29+
edit the auto-generated draft release,
30+
revise,
31+
and click Publish.
32+
33+
4. Advertise the new release in the following places:
34+
35+
* Reddit
36+
Example: https://old.reddit.com/r/scala/comments/pc9k5y/scalajsdom_120_released_this_is_the_first_release
37+
38+
* Scala.js Discord
39+
Example: https://discord.com/channels/632150470000902164/635668814956068864/880575154516819978
40+
41+
* Scala.js gitter
42+
Example: https://gitter.im/scala-js/scala-js?at=612811ec1179346966e36def
43+
44+
* scala-users
45+
Example: https://users.scala-lang.org/t/scala-js-dom-v1-2-0-released/7745
46+
47+
* Twitter
48+
Example: https://twitter.com/japgolly/status/1431011200771379200?s=20

0 commit comments

Comments
 (0)