Skip to content

Prepare CRAN release - #14

Merged
maciekbanas merged 9 commits into
mainfrom
mb/cran-downloads-badge
Jul 17, 2026
Merged

maciekbanas merged 9 commits into
mainfrom
mb/cran-downloads-badge

Conversation

@maciekbanas

@maciekbanas maciekbanas commented Jun 30, 2026 •

Copy link
Copy Markdown
Member

Description

Prepares the 0.1.0 CRAN release:

  • Bump Version to 0.1.0 in DESCRIPTION.
  • Rewrite NEWS.md as a single initial-release changelog. All features are described as added/created (no implication of a prior release), with a short note at the top stating this is the initial CRAN release.
  • Add a CRAN downloads badge to the README, alongside the existing R-CMD-check, Lint, and Codecov badges.
  • Add GitHub (development version) install instructions to the README.

Both README.Rmd (source) and README.md (generated) were updated.

Related Issue(s)

Closes #1
Closes #9

How to test

  • Confirm DESCRIPTION shows Version: 0.1.0.
  • Review NEWS.md: it reads as a single jsplyr 0.1.0 initial release changelog.
  • View the README badges section and confirm the CRAN downloads badge appears, linking to https://cran.r-project.org/package=jsplyr.
  • Confirm the README install section documents both CRAN and GitHub installation.

Co-authored-by: Ona <no-reply@ona.com>
@maciekbanas maciekbanas self-assigned this Jun 30, 2026
@maciekbanas maciekbanas changed the title Add CRAN downloads badge to README Prepare CRAN release Jun 30, 2026
maciekbanas and others added 5 commits June 30, 2026 08:57
- Bump version to 0.1.0
- Rewrite NEWS.md as the initial release changelog
- Add GitHub install instructions to README

Co-authored-by: Ona <no-reply@ona.com>
- Give filter(), select(), and distinct() their own changelog entries
- Add CRAN downloads badge to the CI/CD badge note
- Reword example-app bullet to avoid implying a prior release

Co-authored-by: Ona <no-reply@ona.com>
- Add URL and BugReports to DESCRIPTION
- Add cran-comments.md and exclude it via .Rbuildignore

Co-authored-by: Ona <no-reply@ona.com>
- Add pkgdown GitHub Actions workflow deploying to GitHub Pages
- Set pkgdown site url and add docs URL to DESCRIPTION

Co-authored-by: Ona <no-reply@ona.com>
@maciekbanas
maciekbanas marked this pull request as ready for review June 30, 2026 10:26
maciekbanas and others added 3 commits June 30, 2026 11:26
Point the reference link to the pkgdown reference index instead of an
empty URL, which CRAN flagged as invalid.

Co-authored-by: Ona <no-reply@ona.com>
- Reword Title/Description to drop the redundant 'R' and expand the
  Description with package functionality and implemented methods
- Add \value (@return) tags to all exported methods documenting the
  return class and meaning
- Replace \dontrun{} with if(interactive()){} in examples
- Ignore .devcontainer and .ona in the built package

Co-authored-by: Ona <no-reply@ona.com>
@maciekbanas
maciekbanas requested review from krystian8207 and marcinkowskak and removed request for marcinkowskak July 17, 2026 07:06

@krystian8207 krystian8207 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.

lgtm

@maciekbanas
maciekbanas merged commit 9667bff into main Jul 17, 2026
10 checks passed
@maciekbanas
maciekbanas deleted the mb/cran-downloads-badge branch July 17, 2026 07:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

CRAN release (0.1.0) Build documentation website (pkgdown)

2 participants