Skip to content

Commit 1acc36e

Browse files
authored
Merge pull request #299 from cmu-delphi/release/v2.2.0
Release v2.2.0
2 parents 9586397 + 6f373f8 commit 1acc36e

File tree

138 files changed

+2124
-691
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

138 files changed

+2124
-691
lines changed

.github/release-drafter.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,21 @@ categories:
44
- title: "📚 Content Changes"
55
labels:
66
- "blog"
7-
- "documentation"
7+
- "content"
88
- title: "🚀 Features"
99
labels:
1010
- "enhancement"
1111
- "feature"
1212
- title: "🐛 Bugs Fixes"
1313
labels:
1414
- "bug"
15+
- title: "📕 Documentation"
16+
labels:
17+
- "documentation"
1518
- title: "🧰 Development"
1619
labels:
1720
- "chore"
21+
- "documentation"
1822
change-template: "- #$NUMBER $TITLE"
1923
change-title-escapes: '\<*_&`#@'
2024
template: |

.github/workflows/blog.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ on:
55
paths: # run only when an Rmd file changes
66
- "**.Rmd"
77
- "environment.yml"
8-
- ".github/workflows/ci.yaml"
8+
- ".github/workflows/blog.yaml"
99

1010
jobs:
1111
build:

.github/workflows/ci.yaml

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ jobs:
3333

3434
image:
3535
needs: build
36-
# only on tags and dev branch
37-
if: startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/dev'
36+
# only on main and dev branch
37+
if: startsWith(github.ref, 'refs/heads/main') || github.ref == 'refs/heads/dev'
3838
runs-on: ubuntu-latest
3939
steps:
4040
- name: Check out code
@@ -55,29 +55,29 @@ jobs:
5555
run: |
5656
baseRef="${GITHUB_REF#*/}"
5757
imageTag="${baseRef#*/}"
58+
if [ "$imageTag" = "main" ] ; then
59+
imageTag="latest"
60+
fi
5861
echo "::set-output name=tag::$imageTag"
5962
echo "::set-output name=repo::ghcr.io/${{ github.repository }}"
60-
- name: Push Image Tag
63+
- name: Push Dev Tag
64+
if: startsWith(github.ref, 'refs/heads/dev')
6165
run: |
6266
docker tag repo ${{ steps.tagname.outputs.repo }}:${{ steps.tagname.outputs.tag }}
6367
docker push ${{ steps.tagname.outputs.repo }}:${{ steps.tagname.outputs.tag }}
68+
- name: Extract version
69+
if: startsWith(github.ref, 'refs/heads/main')
70+
id: extract_version
71+
run: node -pe "'::set-output name=version::' + require('./package.json').version"
72+
- name: Push Version Tag Tag
73+
if: startsWith(github.ref, 'refs/heads/main')
74+
run: |
75+
docker tag repo ${{ steps.tagname.outputs.repo }}:v{{ steps.extract_version.outputs.version }}
76+
docker push ${{ steps.tagname.outputs.repo }}:v{{ steps.extract_version.outputs.version }}
6477
- name: Trigger Webhook
6578
run: |
6679
# trigger a webhook update
6780
curl -H "Authorization: Bearer ${{ secrets.DELPHI_DEPLOY_WEBHOOK_TOKEN }}" \
6881
-X POST ${{ secrets.DELPHI_DEPLOY_WEBHOOK_URL }} \
6982
-H "Content-Type: application/x-www-form-urlencoded" \
7083
-d "repository=${{ steps.tagname.outputs.repo }}&tag=${{ steps.tagname.outputs.tag }}"
71-
- name: Push Latest Tag
72-
if: startsWith(github.ref, 'refs/tags/v')
73-
run: |
74-
docker tag repo ${{ steps.tagname.outputs.repo }}:latest
75-
docker push ${{ steps.tagname.outputs.repo }}:latest
76-
- name: Trigger Latest Webhook
77-
if: startsWith(github.ref, 'refs/tags/v')
78-
run: |
79-
# trigger a webhook update
80-
curl -H "Authorization: Bearer ${{ secrets.DELPHI_DEPLOY_WEBHOOK_TOKEN }}" \
81-
-X POST ${{ secrets.DELPHI_DEPLOY_WEBHOOK_URL }} \
82-
-H "Content-Type: application/x-www-form-urlencoded" \
83-
-d "repository=${{ steps.tagname.outputs.repo }}&tag=latest"

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,5 @@
1313
.DS_Store
1414
*.zip
1515
*.tgz
16+
.Rhistory
17+
*.log

.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
*.jpeg
3131
*.ico
3232
*.bib
33+
*.xcf
3334
/themes/delphi/layouts/partials/webp-image.html
3435
/themes/delphi/layouts/shortcodes/apireflink.html
3536
/themes/delphi/layouts/shortcodes/reflink.html

README.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# Delphi Website
22

3-
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/cmu-delpih/www-main)
3+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/cmu-delphi/www-main)
44

55

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/.
79

810
This site is based on [Hugo](https://gohugo.io) and uses [Prettier](https://prettier.io) for formatting.
911

@@ -47,16 +49,9 @@ In RMarkdown things are slightly more different since the R Markdown parser is u
4749
4850
```
4951

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-
5752
## Development Environment
5853

59-
One click: [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/cmu-delpih/www-main)
54+
One click: [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/cmu-delphi/www-main)
6055

6156
### Web Editor Only
6257

@@ -91,7 +86,7 @@ In order to convert the Rmd files to HTML files for Hugo you also need to:
9186
- `local=TRUE` similar to `-D` to process draft files
9287
- `run_hugo=FALSE` to manually run hugo
9388
- `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.
9590
1. Alternatively, run `npm run build:blog`
9691
1. Run Hugo server as usual
9792

@@ -108,12 +103,16 @@ This simplifies the deployment and ensures that we have a blog post even when th
108103

109104
### Release Process
110105

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.
117+
1. Done
119118

config.toml

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,12 @@ relativeURLs = false
2929
parent = "about"
3030
name = "Publications"
3131
url = "/about/publications"
32-
weight = 3
32+
weight = 4
33+
[[menu.main]]
34+
parent = "about"
35+
name = "News"
36+
url = "/about/news"
37+
weight = 4
3338
[[menu.main]]
3439
identifier = "covidcast"
3540
name = "COVIDcast"
@@ -71,6 +76,11 @@ relativeURLs = false
7176
name = "Survey Results"
7277
url = "/covidcast/survey-results"
7378
weight = 51
79+
[[menu.main]]
80+
parent = "covidcast"
81+
name = "Indicator Status Overview"
82+
url = "/covidcast/indicator-status"
83+
weight = 60
7484
[[menu.main]]
7585
parent = "covidcast"
7686
name = "Export Data"
@@ -122,4 +132,4 @@ relativeURLs = false
122132
feedbackDelayMin = 45 # in sec
123133
feedbackDelayMax = 180 # in sec
124134
feedbackDuration = 60 # show it for 60sec
125-
highlightLinks = "/covidcast/,/covidcast/summary,/covidcast/indicator,/signals-dashboard/,/forecast-eval/"
135+
highlightLinks = "/covidcast/,/covidcast/summary,/covidcast/indicator,/covidcast/indicator-status,/forecast-eval/"

content/about/_index.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
---
22
title: Delphi Research Group
33
layout: about
4+
5+
collaborators:
6+
- name: Amazon
7+
group: collaborator
8+
- name: CDC
9+
group: collaborator
10+
- name: Change Healthcare
11+
group: collaborator
12+
- name: Defense Threat Reduction Agency
13+
group: collaborator
14+
- name: Facebook
15+
group: collaborator
16+
- name: Uptake
17+
group: collaborator
18+
- name: Optum
19+
group: collaborator
20+
- name: Google.org
21+
group: sponsor
22+
423
---
524

625
### Who are we?

content/about/news/_index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: News from the Delphi Team
3+
linkTitle: News
4+
layout: single
5+
---
6+
7+
{{<news>}}
File renamed without changes.

0 commit comments

Comments
 (0)