Skip to content

Update documentation prior to RC for CRAN - #611

Merged
StuartWheater merged 19 commits into
datashield:v6.3.4-devfrom
villegar:v6.3.4-dev
Sep 17, 2025
Merged

StuartWheater merged 19 commits into
datashield:v6.3.4-devfrom
villegar:v6.3.4-dev

Conversation

@villegar

@villegar villegar commented Sep 16, 2025 •

Copy link
Copy Markdown
Contributor
  • Updated documentation to resolve NOTES from the tools::checkRd function
  • Updated README file to align with dsBase's README
  • Updated DESCRIPTION file to wrap occurrences of DataSHIELD with single quotes
  • Added CITATION file

@StuartWheater

Copy link
Copy Markdown
Member

Do we need to also run devtools::build_site?

@villegar villegar changed the title Update documentation to resolve NOTES from the tools::checkRd function Update documentation prior to RC for CRAN Sep 16, 2025
@StuartWheater

Copy link
Copy Markdown
Member

Are the 'git actions' test failing significant?
Does a line container ^.github$ added to the .Rbuildignore file?

@StuartWheater

Copy link
Copy Markdown
Member

Does "spelling" need to be added to DESCRIPTION's "Suggests" section

@StuartWheater StuartWheater left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Does a line containing ^.github$ need to be added to the .Rbuildignore file?
  • Are the 'git actions' test failing significant?
  • Does "spelling" need to be added to DESCRIPTION's "Suggests" section

@villegar

Copy link
Copy Markdown
Contributor Author

Are the 'git actions' test failing significant? Does a line container ^.github$ added to the .Rbuildignore file?

The issue with Windows has been solved, but with other runners, like Ubuntu, the issue seems to be that dsBase is not found by the installation:

Error: Error: dsBase package is required in the local R installation for the execution of the tests.

I have updated the .Rbuildignore to ignore the .github directory.

@StuartWheater

Copy link
Copy Markdown
Member

Is "the issue seems to be that dsBase is not found by the installation" going to affect a users experience?

@villegar

Copy link
Copy Markdown
Contributor Author

Is "the issue seems to be that dsBase is not found by the installation" going to affect a users experience?

The introduction of the GitHub Action workflows should not affect the users' experience, this is mostly to automate the checks we do. So, I'm thinking I have probably missed something obvious, like configuring a server in the yaml file. Perhaps we drop the GitHub standard test workflow, so we can get an RC.

@StuartWheater

Copy link
Copy Markdown
Member

Can we disable/skip those tests?

@StuartWheater
StuartWheater merged commit 22a64fe into datashield:v6.3.4-dev Sep 17, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants