Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Pre-release activities #246

Merged
merged 2 commits into from
Feb 16, 2024
Merged

Pre-release activities #246

merged 2 commits into from
Feb 16, 2024

Conversation

donyunardi
Copy link
Contributor

@donyunardi donyunardi commented Feb 14, 2024 •
edited
Loading

Fixes #237

  • Review and update:
    • README.md (check example code)
    • NEWS.md
  • Run urlchecker::url_check() to identify broken links and fix
  • Review functions:
    • @example tag, make sure it runs, fix if otherwise
    • Make sure functions has @return tag to document the return value
    • no \dontrun tag, replace with if(interactive()) if needed
  • Sanity check of all vignettes, make sure there is no typo, no wrong format, etc.
  • Run R CMD check --as-cran make sure everything pass
  • Package Title is not duplicated in Package Description in DESCRIPTION file (e.g. this happens in teal.slice currently)
  • All package names in Title and Description fields of DESCRIPTION file are quoted with '
  • You have checked the Package Release Template https://github.com/insightsengineering/teal.reporter/pull/205/files
  • Make sure there are no ::: in examples
    • if you need to retain the example that uses :::, use getFromNamespace() function.
  • Make sure all teal.* mentions are lower-cased and quoted
  • Make Sure inst/WORDLIST is minimalized
  • Make sure non-exported functions do not have examples
  • Make sure each link to our documentation hosted with pkgdown on github pages do not have /main/ in the address but it has /latest/ instead, so we always expose the documentation of the latest release and not what's currently on main branch but not yet released
  • Correct author list
  • Change teal.reporter.R to remove @docType in favor of "_PACKAGE"
  • Spellcheck NEWS.md catched -> caught
    • Update WORDLIST
      • (should remove roche, hallal, catched)

@donyunardi donyunardi marked this pull request as draft February 14, 2024 22:51
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 14, 2024 •
edited
Loading

badge

Code Coverage Summary

Filename              Stmts    Miss  Cover    Missing
------------------  -------  ------  -------  -----------------------------------------------------------------------------------
R/AddCardModule.R       144       2  98.61%   162, 199
R/Archiver.R             25       0  100.00%
R/ContentBlock.R         18       2  88.89%   52-58
R/DownloadModule.R      207      49  76.33%   95-101, 143, 168-173, 182-186, 189-193, 201-205, 208-212, 219-223, 226-230, 267-271
R/FileBlock.R            13       0  100.00%
R/NewpageBlock.R          2       0  100.00%
R/PictureBlock.R         30       2  93.33%   15, 109
R/Previewer.R           295      56  81.02%   188, 202, 204-207, 210, 213-221, 330-374
R/RcodeBlock.R           15       0  100.00%
R/Renderer.R            113      37  67.26%   87-102, 203, 211, 220, 222-243
R/ReportCard.R           77       4  94.81%   181, 220, 225, 246
R/Reporter.R             94       1  98.94%   254
R/ResetModule.R          55       0  100.00%
R/SimpleReporter.R       30       0  100.00%
R/TableBlock.R            9       0  100.00%
R/TextBlock.R            13       0  100.00%
R/utils.R               171      80  53.22%   7, 38-97, 99, 102-109, 163, 175-177, 287-296
R/yaml_utils.R           81       2  97.53%   70, 268
R/zzz.R                  14      10  28.57%   2-13, 19
TOTAL                  1406     245  82.57%

Diff against main

Filename      Stmts    Miss  Cover
----------  -------  ------  --------
TOTAL             0       0  +100.00%

Results for commit: a4a60db

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 14, 2024 •
edited
Loading

Unit Tests Summary

  1 files   18 suites   12s ⏱️
204 tests 204 ✅ 0 💤 0 ❌
346 runs  346 ✅ 0 💤 0 ❌

Results for commit a4a60db.

♻️ This comment has been updated with latest results.

@donyunardi donyunardi changed the title tidy up news md Pre-release Feb 14, 2024
@donyunardi donyunardi changed the title Pre-release Pre-release activities Feb 14, 2024
@donyunardi donyunardi marked this pull request as ready for review February 14, 2024 23:23
@donyunardi donyunardi requested a review from a team February 14, 2024 23:23
vedhav
vedhav approved these changes Feb 15, 2024
View reviewed changes
Copy link
Contributor

@vedhav vedhav left a comment

Choose a reason for hiding this comment

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

👌🏽 LGTM!

@kartikeyakirar kartikeyakirar mentioned this pull request Feb 15, 2024
Merged
11 tasks
@kartikeyakirar
Copy link
Contributor

@vedhav and @donyunardi I have raised a PR for additional changes. These changes are to keep it consistent with the last few pre-release cleanup. Please take a look and let me know your thoughts.
#247

@donyunardi
Copy link
Contributor Author

Per discussion, I will merge this first and @kartikeyakirar's PR will merge to main as that will require more time to review.

@donyunardi donyunardi merged commit c9ede84 into main Feb 16, 2024
47 checks passed
@donyunardi donyunardi deleted the 237-pre-release-activities@main branch February 16, 2024 15:51
kartikeyakirar added a commit that referenced this pull request Feb 19, 2024
@kartikeyakirar @donyunardi
@chlebowa @averissimo
post-release-cleanup (#247)
78a5aab 
this PR is part of
#246

I have added few changes to keep it consistent with other
pre-release-cleanup

- [x] title and description to have sentence cases.
- [x] common document for module instead of separate for UI and server
   - [x]         download_report_button
   - [x]          add_card_button
   - [x]          reporter_previewer
   - [x]           reset_report_button
   - [x]           simple_reporter
- [x] removing indentation-linter
- [x] removing \cr tags 
- [x] putting backticks on keywords e.g R6, shiny or [pkg]
- [x] removing `pkg::` call from examples and use `library(pkg)`

---------

Signed-off-by: kartikeya kirar <[email protected]>
Signed-off-by: André Veríssimo <[email protected]>
Co-authored-by: Dony Unardi <[email protected]>
Co-authored-by: Aleksander Chlebowski <[email protected]>
Co-authored-by: André Veríssimo <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vedhav vedhav vedhav approved these changes

Assignees
No one assigned
Labels
core
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Pre-release activities
3 participants
@donyunardi @kartikeyakirar @vedhav