Skip to content

Commit 96518ad

Browse files
authored
Merge pull request #408 from cmu-delphi/ds/ci2
testing
2 parents f4aefe9 + b2b8355 commit 96518ad

File tree

5 files changed

+39
-73
lines changed

5 files changed

+39
-73
lines changed

.github/pull_request_template.md

+13-8
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
11
### Checklist
22

33
Please:
4-
- [ ] Make sure this PR is against "dev", not "main".
5-
- [ ] Request a review from one of the current epiprocess main reviewers:
6-
brookslogan, nmdefries.
7-
- [ ] Describe changes made in NEWS.md, making sure breaking changes
8-
(backwards-incompatible changes to the documented interface) are noted.
9-
The right location for this may be in flux (see
10-
[here](https://github.com/cmu-delphi/epiprocess/pull/398)).
4+
5+
- [ ] Make sure this PR is against "dev", not "main".
6+
- [ ] Request a review from one of the current epiprocess main reviewers:
7+
brookslogan, nmdefries.
8+
- [ ] Makes sure to bump the version number in `DESCRIPTION` and `NEWS.md`.
9+
Always increment the patch version number (the third number), unless you are
10+
making a release PR from dev to main, in which case increment the minor
11+
version number (the second number).
12+
- [ ] Describe changes made in NEWS.md, making sure breaking changes
13+
(backwards-incompatible changes to the documented interface) are noted.
14+
Collect the changes under the next release number (e.g. if you are on
15+
0.7.2, then write your changes under the 0.8 heading).
1116

1217
### Change explanations for reviewer
1318

1419
### Magic GitHub syntax to mark associated Issue(s) as resolved when this is merged into the default branch
1520

16-
- Resolves #{issue number}
21+
- Resolves #{issue number}

.github/workflows/auto_semver_bump.yaml

-39
This file was deleted.

.github/workflows/pkgdown.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ jobs:
4141
env:
4242
DELPHI_EPIDATA_KEY: ${{ secrets.SECRET_EPIPROCESS_GHACTIONS_DELPHI_EPIDATA_KEY }}
4343
run: |
44-
if (startsWith("${{ GITHUB_EVENT_NAME }}", "pull_request")) {
45-
mode <- ifelse("${{ GITHUB_BASE_REF }}" == "main", "release", "devel")
44+
if (startsWith("${{ github.event_name }}", "pull_request")) {
45+
mode <- ifelse("${{ github.base_ref }}" == "main", "release", "devel")
4646
} else {
47-
mode <- ifelse("${{ GITHUB_REF_NAME }}" == "main", "release", "devel")
47+
mode <- ifelse("${{ github.ref_name }}" == "main", "release", "devel")
4848
}
4949
pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE, override=list(PKGDOWN_DEV_MODE=mode))
5050
shell: Rscript {0}

DEVELOPMENT.md

+15-18
Original file line numberDiff line numberDiff line change
@@ -35,25 +35,22 @@ R -e 'devtools::document()'
3535
python -m http.server -d docs
3636
```
3737

38-
For `pkgdown` to correctly generate both public (`main`) and `dev` documentation sites, the package version in `DESCRIPTION` on `dev` must have four components, and be of the format `x.x.x.9000`. The package version on `main` must be in the format `x.x.x`.
39-
40-
The documentation website is updated on push or pull request to the `main` and `dev` branches.
38+
## Versioning
39+
40+
Please follow the guidelines in the PR template document (reproduced here):
41+
42+
- [ ] Make sure this PR is against "dev", not "main".
43+
- [ ] Request a review from one of the current epiprocess main reviewers:
44+
brookslogan, nmdefries.
45+
- [ ] Makes sure to bump the version number in `DESCRIPTION` and `NEWS.md`.
46+
Always increment the patch version number (the third number), unless you are
47+
making a release PR from dev to main, in which case increment the minor
48+
version number (the second number).
49+
- [ ] Describe changes made in NEWS.md, making sure breaking changes
50+
(backwards-incompatible changes to the documented interface) are noted.
51+
Collect the changes under the next release number (e.g. if you are on
52+
0.7.2, then write your changes under the 0.8 heading).
4153

4254
## Release process
4355

44-
### Manual
45-
4656
TBD
47-
48-
### Automated (currently unavailable)
49-
50-
The release consists of multiple steps which can be all done via the GitHub website:
51-
52-
1. Go to [create_release GitHub Action](https://github.com/cmu-delphi/epidatr/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.
53-
2. The action will prepare a new release and will end up with a new [Pull Request](https://github.com/cmu-delphi/epidatr/pulls)
54-
3. Let the code owner review the PR and its changes and let the CI check whether everything builds successfully
55-
4. Once approved and merged, another GitHub action job starts which automatically will
56-
1. create a git tag
57-
2. create another [Pull Request](https://github.com/cmu-delphi/epidatr/pulls) to merge the changes back to the `dev` branch
58-
3. create a [GitHub release](https://github.com/cmu-delphi/epidatr/releases) with automatically derived release notes
59-
5. Release to CRAN

NEWS.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
1-
# epiprocess 0.7.2.9999
1+
# epiprocess
2+
3+
Pre-1.0.0 numbering scheme: 0.x will indicate releases, while 0.x.y will indicate PR's.
4+
5+
# epiprocess 0.8
26

37
## Improvements
48

59
* `epi_slide` computations are now 2-4 times faster after changing how
610
reference time values, made accessible within sliding functions, are
711
calculated (#397).
12+
* regenerated the `jhu_csse_daily_subset` dataset with the latest versions of
13+
the data from the API
14+
* changed approach to versioning, see DEVELOPMENT.md for details
815

916
# epiprocess 0.7.1.9999
1017

11-
Pre-1.0.0 numbering scheme: 0.x will indicate releases, while 0.7.x will indicate PR's.
12-
1318
## Breaking changes
1419

1520
* Switched `epi_df`'s `other_keys` default from `NULL` to `character(0)`; PR #390
@@ -25,8 +30,6 @@ Pre-1.0.0 numbering scheme: 0.x will indicate releases, while 0.7.x will indicat
2530

2631
* Updated vignettes for compatibility with epidatr 1.0.0 in PR #377.
2732

28-
# epiprocess 0.7.0
29-
3033
## Breaking changes
3134

3235
* Changes to `epi_slide` and `epix_slide`:

0 commit comments

Comments
 (0)