diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 747fdd1c..83a0dbad 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,29 +1,30 @@ -### Thank you for your Pull Request! +### Thank you for your Pull Request! -We have developed a Pull Request template to aid you and our reviewers. Completing the below tasks helps to ensure our reviewers can maximize their time on your code as well as making sure the xportr codebase remains robust and consistent. +We have developed a Pull Request template to aid you and our reviewers. Completing the below tasks helps to ensure our reviewers can maximize their time on your code as well as making sure the xportr codebase remains robust and consistent. ### The scope of `{xportr}` -`{xportr}`'s scope is to enable R users to write out submission compliant `xpt` files that can be delivered to a Health Authority or to downstream validation software programs. We see labels, lengths, types, ordering and formats from a dataset specification object (SDTM and ADaM) as being our primary focus. We also see messaging and warnings to users around applying information from the specification file as a primary focus. Please make sure your Pull Request meets this **scope of {xportr}**. If your Pull Request moves beyond this scope, please get in touch with the `{xportr}` team on [slack](https://pharmaverse.slack.com/archives/C030EB2M4GM) or create an issue to discuss. +`{xportr}`'s scope is to enable R users to write out submission compliant `xpt` files that can be delivered to a Health Authority or to downstream validation software programs. We see labels, lengths, types, ordering and formats from a dataset specification object (SDTM and ADaM) as being our primary focus. We also see messaging and warnings to users around applying information from the specification file as a primary focus. Please make sure your Pull Request meets this **scope of {xportr}**. If your Pull Request moves beyond this scope, please get in touch with the `{xportr}` team on [slack](https://pharmaverse.slack.com/archives/C030EB2M4GM) or create an issue to discuss. Please check off each task box as an acknowledgment that you completed the task. This checklist is part of the Github Action workflows and the Pull Request will not be merged into the `devel` branch until you have checked off each task. ### Changes Description -_(descriptions of changes)_ +_(descriptions of changes)_ ### Task List - [ ] The spirit of xportr is met in your Pull Request - [ ] Place Closes # into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update) -- [ ] Summary of changes filled out in the above Changes Description. Can be removed or left blank if changes are minor/self-explanatory. -- [ ] Code is formatted according to the [tidyverse style guide](https://style.tidyverse.org/). Use `styler` package and functions to style files accordingly. +- [ ] Summary of changes filled out in the above Changes Description. Can be removed or left blank if changes are minor/self-explanatory. +- [ ] Code is formatted according to the [tidyverse style guide](https://style.tidyverse.org/). Use `styler` package and functions to style files accordingly. - [ ] Updated relevant unit tests or have written new unit tests. See our [Wiki](https://github.com/atorus-research/xportr/wiki/Style-Guide-for-Unit-Tests) for conventions used in this package. - [ ] Creation/updated relevant roxygen headers and examples. See our [Wiki](https://github.com/atorus-research/xportr/wiki/Style-Guide-for-Roxygen-Headers) for conventions used in this package. - [ ] Run `devtools::document()` so all `.Rd` files in the `man` folder and the `NAMESPACE` file in the project root are updated appropriately - [ ] Run `pkgdown::build_site()` and check that all affected examples are displayed correctly and that all new/updated functions occur on the "Reference" page. - [ ] Update NEWS.md if the changes pertain to a user-facing function (i.e. it has an @export tag) or documentation aimed at users (rather than developers) +- [ ] Make sure that the pacakge version in the NEWS.md and DESCRIPTION file is same. Don't worry about updating the version because it will be auto-updated using the `vbump.yaml` CI. - [ ] Address any updates needed for vignettes and/or templates - [ ] Link the issue Development Panel so that it closes after successful merging. -- [ ] Fix merge conflicts -- [ ] Pat yourself on the back for a job well done! Much love to your accomplishment! +- [ ] Fix merge conflicts +- [ ] Pat yourself on the back for a job well done! Much love to your accomplishment! diff --git a/.github/workflows/check-links.yml b/.github/workflows/check-links.yml index 230e521b..21e50fa5 100644 --- a/.github/workflows/check-links.yml +++ b/.github/workflows/check-links.yml @@ -2,9 +2,11 @@ name: Check URLs ๐Ÿ”— on: push: - branches: [main] + branches: + - main pull_request: - branches: [main, devel] + branches: + - main jobs: links: diff --git a/.github/workflows/check-standard.yaml b/.github/workflows/check-standard.yaml index c9239381..05c1b71c 100644 --- a/.github/workflows/check-standard.yaml +++ b/.github/workflows/check-standard.yaml @@ -4,9 +4,11 @@ name: R-CMD-check ๐Ÿ“ฆ on: push: - branches: [main, devel] + branches: + - main pull_request: - branches: [main, devel] + branches: + - main jobs: R-CMD-check: @@ -18,11 +20,11 @@ jobs: fail-fast: false matrix: config: - - {os: macOS-latest, r: 'release'} - - {os: windows-latest, r: 'release'} - - {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'} - - {os: ubuntu-latest, r: 'release'} - - {os: ubuntu-latest, r: 'oldrel-1'} + - { os: macOS-latest, r: "release" } + - { os: windows-latest, r: "release" } + - { os: ubuntu-latest, r: "devel", http-user-agent: "release" } + - { os: ubuntu-latest, r: "release" } + - { os: ubuntu-latest, r: "oldrel-1" } env: GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index cee715dc..85e6a1b3 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -4,9 +4,11 @@ name: Check Lint ๐Ÿงน on: push: - branches: [main] + branches: + - main pull_request: - branches: [main, devel] + branches: + - main jobs: lint: diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml index 16404107..967eb46d 100644 --- a/.github/workflows/pkgdown.yaml +++ b/.github/workflows/pkgdown.yaml @@ -4,7 +4,6 @@ on: push: branches: - main - - master jobs: pkgdown: diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml index 42c7e327..5c7adb19 100644 --- a/.github/workflows/spellcheck.yml +++ b/.github/workflows/spellcheck.yml @@ -5,11 +5,9 @@ on: push: branches: - main - - devel pull_request: branches: - main - - devel concurrency: group: spelling-${{ github.event.pull_request.number || github.ref }} diff --git a/.github/workflows/style.yml b/.github/workflows/style.yml index fc779f37..410da4b5 100644 --- a/.github/workflows/style.yml +++ b/.github/workflows/style.yml @@ -2,9 +2,11 @@ name: Check Style ๐ŸŽจ on: push: - branches: [main] + branches: + - main pull_request: - branches: [main, devel] + branches: + - main concurrency: group: style-${{ github.event.pull_request.number || github.ref }} diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml index dadf5abe..43ae648d 100644 --- a/.github/workflows/test-coverage.yaml +++ b/.github/workflows/test-coverage.yaml @@ -4,11 +4,9 @@ on: push: branches: - main - - master pull_request: branches: - main - - master jobs: test-coverage: diff --git a/.github/workflows/vbump.yaml b/.github/workflows/vbump.yaml new file mode 100644 index 00000000..a2091019 --- /dev/null +++ b/.github/workflows/vbump.yaml @@ -0,0 +1,14 @@ +name: Version Bump โฌ†๏ธ + +on: + push: + branches: + - main + +jobs: + vbump: + name: Version Bump ๐Ÿคœ๐Ÿค› + if: github.event_name == 'push' + uses: insightsengineering/r.pkg.template/.github/workflows/version-bump.yaml@main + secrets: + REPO_GITHUB_TOKEN: ${{ secrets.REPO_GITHUB_TOKEN }} diff --git a/DESCRIPTION b/DESCRIPTION index 4e813ef9..61e81239 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: xportr Title: Utilities to Output CDISC SDTM/ADaM XPT Files -Version: 0.3.1.9000 +Version: 0.3.1 Authors@R: c( person(given = "Eli", diff --git a/NEWS.md b/NEWS.md index 07babb71..08ab28de 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,17 +1,15 @@ -# xportr (development version) +# xportr 0.3.1 ## New Features and Bug Fixes +* Make `xportr_type()` drop factor levels when coercing variables + ## Documentation * Set up Development version of Website (#187) ## Deprecation and Breaking Changes -# xportr 0.3.1 - -* Make `xportr_type()` drop factor levels when coercing variables - # xportr 0.3.0 ## New Features and Bug Fixes