Skip to content

Document release process #541

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 1, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
How to Perform a Release
========================

1. The first step is to create a tag, push it, and let GitHub Actions do the release.

```sh
# For v1.x.y
ver=1.2.0 # change this to new version
git checkout series/1.x
git checkout -b topic/v$ver
echo "ThisBuild / version := \"$ver\" // Workaround for #504" > version.sbt
git add version.sbt
git commit -m "Setting version to v$ver"
git tag -s v$ver
git push --tags

# For v2.x onwards
ver=2.0.0 # change this to new version
git checkout master
git tag -s v$ver
git push --tags
```


2. Wait for the release to complete.
https://github.com/scala-js/scala-js-dom/actions/workflows/release.yml

3. Go to GitHub releases (https://github.com/scala-js/scala-js-dom/releases),
edit the auto-generated draft release,
revise,
and click Publish.

4. Advertise the new release in the following places:

* Reddit
Example: https://old.reddit.com/r/scala/comments/pc9k5y/scalajsdom_120_released_this_is_the_first_release

* Scala.js Discord
Example: https://discord.com/channels/632150470000902164/635668814956068864/880575154516819978

* Scala.js gitter
Example: https://gitter.im/scala-js/scala-js?at=612811ec1179346966e36def

* scala-users
Example: https://users.scala-lang.org/t/scala-js-dom-v1-2-0-released/7745

* Twitter
Example: https://twitter.com/japgolly/status/1431011200771379200?s=20