You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-19Lines changed: 18 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,11 @@
1
1
# Delphi Website
2
2
3
-
[](https://gitpod.io/#https://github.com/cmu-delpih/www-main)
3
+
[](https://gitpod.io/#https://github.com/cmu-delphi/www-main)
4
4
5
5
6
-
Delphi's homepage at https://cmu-delphi-main.netlify.app/
6
+
The current stable `main` version is deployed at https://delphi.cmu.edu and https://cmu-delphi-main.netlify.app/.
7
+
8
+
The next `dev` version is deployed at https://staging.delphi.cmu.edu/ and https://dev--cmu-delphi-main.netlify.app/.
7
9
8
10
This site is based on [Hugo](https://gohugo.io) and uses [Prettier](https://prettier.io) for formatting.
9
11
@@ -47,16 +49,9 @@ In RMarkdown things are slightly more different since the R Markdown parser is u
47
49
48
50
```
49
51
50
-
### Data
51
-
52
-
In addition, there in the `/data` directory there are the following listings in YAML syntax
53
-
54
-
-`authors.yaml` list of blog authors referenced in the `authors` field in blog posts. This list is used to generated the author information at the end of a blog post
55
-
-`supporters.yaml` list of supporters/collaborators
56
-
57
52
## Development Environment
58
53
59
-
One click: [](https://gitpod.io/#https://github.com/cmu-delpih/www-main)
54
+
One click: [](https://gitpod.io/#https://github.com/cmu-delphi/www-main)
60
55
61
56
### Web Editor Only
62
57
@@ -91,7 +86,7 @@ In order to convert the Rmd files to HTML files for Hugo you also need to:
91
86
-`local=TRUE` similar to `-D` to process draft files
92
87
-`run_hugo=FALSE` to manually run hugo
93
88
-`build_rmd=TRUE` force a (re)build of the Rmd pages
94
-
1. Run blogdown to convert a single file to HTML: `Rscript -e 'blogdown::build_site(local=TRUE, run_hugo=FALSE, build_rmd="content/blog/<NAME>.Rmd")'`
89
+
1. Run blogdown to convert a single file to HTML: `Rscript -e 'blogdown::build_site(local=TRUE, run_hugo=FALSE, build_rmd="content/blog/<NAME>.Rmd")'` where `<NAME>` should be replaced by the name of the Rmd file.
95
90
1. Alternatively, run `npm run build:blog`
96
91
1. Run Hugo server as usual
97
92
@@ -108,12 +103,16 @@ This simplifies the deployment and ensures that we have a blog post even when th
108
103
109
104
### Release Process
110
105
111
-
The release process is based on [release-it](https://github.com/release-it/release-it). To create a release, run
112
-
113
-
1. create/checkout the release branch `release` and push to origin
114
-
1. run `npm run release` and publish the release
115
-
1. create a PR that merges the `release` branch in the `main` branch
116
-
1. create a PR that merges the `main` branch back into the `dev` branch
117
-
118
-
Then go to the release page and update short description of the changes made.
106
+
The release consists of multiple steps which can be all done via the GitHub website:
107
+
108
+
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.
109
+
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)
110
+
1. Let the code owner review the PR and its changes and let the CI check whether everything builds successfully
111
+
1. Once approved and merged, another GitHub action job starts which automatically will
112
+
1. create a git tag
113
+
1. create another [Pull Request](https://github.com/cmu-delphi/www-main/pulls) to merge the changes back to the `dev` branch
114
+
1. create a [GitHub release](https://github.com/cmu-delphi/www-main/releases) with automatically derived release notes
115
+
1. create docker image and the production system will be notified to pull this update
116
+
1. Once the jobs are completed the new release should be available at https://delphi.cmu.edu within minutes.
0 commit comments