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: DEVELOPMENT.md
+15-18
Original file line number
Diff line number
Diff line change
@@ -35,25 +35,22 @@ R -e 'devtools::document()'
35
35
python -m http.server -d docs
36
36
```
37
37
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).
41
53
42
54
## Release process
43
55
44
-
### Manual
45
-
46
56
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
0 commit comments