Skip to content

Commit 7ece867

Browse files
committed
doc: update development guide
1 parent eb3f91c commit 7ece867

File tree

1 file changed

+19
-22
lines changed

1 file changed

+19
-22
lines changed

DEVELOPMENT.md

Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ install.packages(c('devtools', 'pkgdown', 'styler', 'lintr')) # install dev depe
55
devtools::install_deps(dependencies = TRUE) # install package dependencies
66
devtools::document() # generate package meta data and man files
77
devtools::build() # build package
8-
98
```
109

1110
## Validating the package
@@ -20,41 +19,39 @@ devtools::check() # check package for errors
2019

2120
## Developing the documentation site
2221

23-
The [documentation site](https://cmu-delphi.github.io/epidatr/) is built off of the `main` branch. The `dev` version of the site is available at https://cmu-delphi.github.io/epidatr/dev.
22+
Our CI is setup to build the [main documentation site](https://cmu-delphi.github.io/epidatr/) off of the `main` branch, while the [`dev` version of the site](https://cmu-delphi.github.io/epidatr/dev) is built off the `dev` branch.
2423

25-
The documentation site can be previewed locally by running in R
24+
The documentation site can be previewed locally by running in R:
2625

2726
```r
27+
# Should automatically open a browser
2828
pkgdown::build_site(preview=TRUE)
2929
```
3030

31-
The `main` version is available at `file:///<local path>/epidatr/docs/index.html` and `dev` at `file:///<local path>/epidatr/docs/dev/index.html`.
31+
If the above does not open a browser, you can try using a Python server from the command line:
3232

33-
You can also build the docs manually and launch the site with python. From the terminal, this looks like
3433
```bash
3534
R -e 'devtools::document()'
35+
R -e 'pkgdown::build_site()'
3636
python -m http.server -d docs
3737
```
3838

39-
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+
## Versioning
4040

41-
The documentation website is updated on push or pull request to the `main` and `dev` branches.
41+
Please follow the guidelines in the PR template document (reproduced here):
4242

43-
## Release process
43+
- [ ] Make sure this PR is against "dev", not "main".
44+
- [ ] Request a review from one of the current epiprocess main reviewers:
45+
brookslogan, nmdefries.
46+
- [ ] Makes sure to bump the version number in `DESCRIPTION` and `NEWS.md`.
47+
Always increment the patch version number (the third number), unless you are
48+
making a release PR from dev to main, in which case increment the minor
49+
version number (the second number).
50+
- [ ] Describe changes made in NEWS.md, making sure breaking changes
51+
(backwards-incompatible changes to the documented interface) are noted.
52+
Collect the changes under the next release number (e.g. if you are on
53+
0.7.2, then write your changes under the 0.8 heading).
4454

45-
### Manual
55+
## Release process
4656

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

0 commit comments

Comments
 (0)