From c1356524e2159beb5a50ee92764221d5679354c8 Mon Sep 17 00:00:00 2001 From: Samuel Gratzl Date: Wed, 31 Mar 2021 11:44:17 -0400 Subject: [PATCH 1/3] docs: fix gitpod.io link --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3bfd2a1d5..7b16c450e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Delphi Website -[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/cmu-delpih/www-main) +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/cmu-delphi/www-main) Delphi's homepage at https://cmu-delphi-main.netlify.app/ @@ -49,7 +49,7 @@ In RMarkdown things are slightly more different since the R Markdown parser is u ## Development Environment -One click: [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/cmu-delpih/www-main) +One click: [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/cmu-delphi/www-main) ### Web Editor Only From ac6df66a2284113ab369bfeeb2d71c1750e83007 Mon Sep 17 00:00:00 2001 From: Samuel Gratzl Date: Wed, 31 Mar 2021 11:51:13 -0400 Subject: [PATCH 2/3] docs: update release process --- README.md | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 7b16c450e..06f75c4da 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,9 @@ [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/cmu-delphi/www-main) -Delphi's homepage at https://cmu-delphi-main.netlify.app/ +The current stable `main` version is deployed at https://delphi.cmu.edu and https://cmu-delphi-main.netlify.app/. + +The next `dev` version is deployed at https://staging.delphi.cmu.edu/ and https://dev--cmu-delphi-main.netlify.app/. This site is based on [Hugo](https://gohugo.io) and uses [Prettier](https://prettier.io) for formatting. @@ -84,7 +86,7 @@ In order to convert the Rmd files to HTML files for Hugo you also need to: - `local=TRUE` similar to `-D` to process draft files - `run_hugo=FALSE` to manually run hugo - `build_rmd=TRUE` force a (re)build of the Rmd pages -1. Run blogdown to convert a single file to HTML: `Rscript -e 'blogdown::build_site(local=TRUE, run_hugo=FALSE, build_rmd="content/blog/.Rmd")'` +1. Run blogdown to convert a single file to HTML: `Rscript -e 'blogdown::build_site(local=TRUE, run_hugo=FALSE, build_rmd="content/blog/.Rmd")'` where `` should be replaced by the name of the Rmd file. 1. Alternatively, run `npm run build:blog` 1. Run Hugo server as usual @@ -101,12 +103,16 @@ This simplifies the deployment and ensures that we have a blog post even when th ### Release Process -The release process is based on [release-it](https://github.com/release-it/release-it). To create a release, run - -1. create/checkout the release branch `release` and push to origin -1. run `npm run release` and publish the release -1. create a PR that merges the `release` branch in the `main` branch -1. create a PR that merges the `main` branch back into the `dev` branch - -Then go to the release page and update short description of the changes made. +The release consists of multiple stets which can be all done via the GitHub website: + +1. Go to [create_release GitHub Action](https://github.com/cmu-delphi/www-main/actions/workflows/create_release.yml) and click the `Run workflow` button. Enter the next version number or one of the magic keywords (patch, minor, major) and hit the green `Run workflow` button. +1. The action will prepare a new release and will end up with a new [Pull Request](https://github.com/cmu-delphi/www-main/pulls) +1. Let the code owner review the PR and its changes and let the CI check whether everything builds successfully +1. Once approved and merged, another GitHub action job starts which automatically will + 1. create a git tag + 1. create another [Pull Request](https://github.com/cmu-delphi/www-main/pulls) to merge the changes back to the `dev` branch + 1. create a [GitHub release](https://github.com/cmu-delphi/www-main/releases) with automatically derived release notes + 1. create docker image and the production system will be notified to pull this update +1. Once the jobs are completed the new release should be available at https://delphi.cmu.edu within minutes. +1. Done From 5a52524be932108340aba45112251ec5031ac8f3 Mon Sep 17 00:00:00 2001 From: Samuel Gratzl Date: Wed, 31 Mar 2021 15:31:54 -0400 Subject: [PATCH 3/3] docs: fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 06f75c4da..780b45efa 100644 --- a/README.md +++ b/README.md @@ -103,7 +103,7 @@ This simplifies the deployment and ensures that we have a blog post even when th ### Release Process -The release consists of multiple stets which can be all done via the GitHub website: +The release consists of multiple steps which can be all done via the GitHub website: 1. Go to [create_release GitHub Action](https://github.com/cmu-delphi/www-main/actions/workflows/create_release.yml) and click the `Run workflow` button. Enter the next version number or one of the magic keywords (patch, minor, major) and hit the green `Run workflow` button. 1. The action will prepare a new release and will end up with a new [Pull Request](https://github.com/cmu-delphi/www-main/pulls)