From 53cf7ae375f16395fcbd59b0c863391a754afee6 Mon Sep 17 00:00:00 2001 From: David Barri Date: Wed, 1 Sep 2021 09:49:59 +1000 Subject: [PATCH 1/3] Document release process Closes #510 --- RELEASING.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 RELEASING.md diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 000000000..28f7241a6 --- /dev/null +++ b/RELEASING.md @@ -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 + 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 + 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 git 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: ? + + * Scala.js gitter + Example: ? + + * 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 From 8073786a868db53c30134d0f7652aeffc860f31f Mon Sep 17 00:00:00 2001 From: David Barri Date: Wed, 1 Sep 2021 10:06:33 +1000 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: Arman Bilge --- RELEASING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/RELEASING.md b/RELEASING.md index 28f7241a6..c6e5924b7 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -28,7 +28,7 @@ How to Perform a Release 3. Go to GitHub releases (https://github.com/scala-js/scala-js-dom/releases), edit the auto-generated draft release, revise, - and git Publish. + and click Publish. 4. Advertise the new release in the following places: @@ -36,10 +36,10 @@ How to Perform a Release Example: https://old.reddit.com/r/scala/comments/pc9k5y/scalajsdom_120_released_this_is_the_first_release * Scala.js Discord - Example: ? + Example: https://discord.com/channels/632150470000902164/635668814956068864/880575154516819978 * Scala.js gitter - Example: ? + 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 From 7899e1f3bcc145c99866cd113e12c454bd0045c0 Mon Sep 17 00:00:00 2001 From: David Barri Date: Wed, 1 Sep 2021 10:09:58 +1000 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Arman Bilge --- RELEASING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/RELEASING.md b/RELEASING.md index c6e5924b7..99d430d8d 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -5,7 +5,7 @@ How to Perform a Release ```sh # For v1.x.y - ver=1.2.0 + 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 @@ -15,7 +15,7 @@ How to Perform a Release git push --tags # For v2.x onwards - ver=2.0.0 + ver=2.0.0 # change this to new version git checkout master git tag -s v$ver git push --tags