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.

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

Issue 250: Ground work to shift development to main from develop #256

Merged
merged 15 commits into from Apr 25, 2023

Conversation

seabbs
Copy link
Collaborator

@seabbs seabbs commented Apr 25, 2023

Description

This PR closes #250.

As discussed in #250 there are a range of benefits to shifting development to main with the key benefits of using develop having been eroded by enabling release-only building on R-universe. This PR updates the README and contributing guide to drop mentions of develop and make distinctions clear between the various available package versions.

It also:

  • Adds an action to automatically render the README.Rmd when it is touched.
  • Fleshes out some of the install sections
  • Adds a link out to our Docker container as an alternative.

This PR does not remove the develop triggers in our CI as this would break the current development workflow and does not remove the develop branch as we are still using it for this minor release.

Checklist

  • My PR is based on a package issue and I have explicitly linked it.
  • I have included the target issue or issues in the PR title in the for Issue(s) issue-numbers: PR title
  • I have read the contribution guidelines.
  • I have tested my changes locally.
  • I have updated the documentation if required.
  • My code follows the established coding standards.
  • I have added a news item linked to this PR.
  • I have updated the package development version by one increment in both NEWS.md and the DESCRIPTION.
  • I have reviewed CI checks for this PR and addressed them as far as I am able.

@seabbs seabbs added enhancement New feature or request infrastructure labels Apr 25, 2023
@seabbs seabbs requested a review from Bisaloo April 25, 2023 13:11
@seabbs seabbs self-assigned this Apr 25, 2023
@codecov
Copy link

codecov bot commented Apr 25, 2023

Codecov Report

Merging #256 (08f1606) into develop (485c041) will not change coverage.
The diff coverage is n/a.

❗ Current head 08f1606 differs from pull request most recent head 1414b0f. Consider uploading reports for the commit 1414b0f to get more accurate results

@@           Coverage Diff            @@
##           develop     #256   +/-   ##
========================================
  Coverage    96.82%   96.82%           
========================================
  Files           15       15           
  Lines         1574     1574           
========================================
  Hits          1524     1524           
  Misses          50       50           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@seabbs seabbs mentioned this pull request Apr 25, 2023
4 tasks
@seabbs seabbs requested review from sbfnk and pearsonca April 25, 2023 13:16
README.Rmd Outdated Show resolved Hide resolved
README.Rmd Outdated Show resolved Hide resolved
NEWS.md Show resolved Hide resolved
README.Rmd Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@pearsonca pearsonca left a comment

Choose a reason for hiding this comment

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

Seems fine except: something to fix with the renderer?

A few other asides in comments; take 'em or leave 'em.

@seabbs seabbs removed the request for review from sbfnk April 25, 2023 13:50
@seabbs seabbs requested a review from pearsonca April 25, 2023 14:29
@seabbs seabbs linked an issue Apr 25, 2023 that may be closed by this pull request
4 tasks
@seabbs seabbs merged commit a976c6c into develop Apr 25, 2023
8 of 10 checks passed
@seabbs seabbs deleted the seabbs/issue250 branch April 25, 2023 14:51
seabbs added a commit that referenced this pull request Apr 25, 2023
@github-actions github-actions bot restored the seabbs/issue250 branch April 25, 2023 14:52
@seabbs seabbs deleted the seabbs/issue250 branch April 25, 2023 16:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request infrastructure
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Drop use of develop branch
4 participants