Skip to content

Commit

Permalink
Document how to make a release
Browse files Browse the repository at this point in the history
  • Loading branch information
grst committed Jan 22, 2024
1 parent aa6db88 commit 92c49bb
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 3 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Contribution guidelines

After making changes, you'll need to take the following steps:

- Rebuild roxygen: `Rscript -e "devtools::document()"`
- Run R CMD CHECK: `Rscript -e 'devtools::check()'`
- Build documentation website: `Rscript -e 'pkgdown::build_site_github_pages(install=TRUE)'`
- Push the `/docs` folder to the `gh-pages` branch of the repo to update the documentation website

## Making a release

- bump the version according to semver.org
- make a release on GitHub

After making the release, bump the version to x.x.x.9000 to mark it as a development version
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: PersonalisIO
Title: Read Personalis data into MultiAssayExperiment objects
Version: 0.1.9000
Version: 0.2.0
Authors@R:
person("Gregor", "Sturm", , "gregor.sturm@boehringer-ingelheim.com", role = c("aut", "cre"))
Description: This package provides convenience functions for reading real-world evidence data provided by Personalis into Bioconductor MultiAssayExperiment objects.
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ mae

For more details, see the [Documentation](https://boehringer-ingelheim.github.io/Personalis-io/):

- [Vignette](https://boehringer-ingelheim.github.io/Personalis-io/articles/personalis.html)
- [Vignette](https://boehringer-ingelheim.github.io/Personalis-io/articles/PersonalisIO.html)
- [function reference](https://boehringer-ingelheim.github.io/Personalis-io/reference/index.html)

## Installation
Expand All @@ -53,4 +53,4 @@ Please use the [issue tracker](https://github.com/Boehringer-Ingelheim/Personali

## Credits

This package was developed by [Gregor Sturm](https://github.com/grst) with input from Neetika Nath and Germán Leparc.
This package was developed by [Gregor Sturm](https://github.com/grst) with contributions from [Christopher Mohr](https://github.com/christopher-mohr), Neetika Nath and Germán Leparc.

0 comments on commit 92c49bb

Please sign in to comment.