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

added check gha action #32 #34

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

added check gha action #32 #34

wants to merge 5 commits into from

Conversation

awasyn
Copy link
Collaborator

@awasyn awasyn commented Oct 4, 2024

Description

The commit adds rworkflows which is a suite of tools to make it easy for R developers to implement reproducible best practices on GitHub.
Check: https://github.com/neurogenomics/rworkflows
Issue: #32

What kind of change(s) are included?

  • Feature (adds or updates new capabilities)
  • Enhancement (adds functionality).

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

  • I have read and followed the CONTRIBUTING.md guidelines.
  • I have searched for existing content to ensure this is not a duplicate.
  • I have performed a self-review of these additions (including spelling, grammar, and related).
  • I have added comments to my code to help provide understanding.
  • I have added a test which covers the code changes found within this PR.
  • I have deleted all non-relevant text in this pull request template.
  • Reviewer assignment: Tag a relevant team member to review and approve the changes.

Signed-off-by: Awa Synthia <[email protected]>
@awasyn
Copy link
Collaborator Author

awasyn commented Oct 4, 2024

@jananiravi Can you review my PR?

@the-mayer the-mayer added the enhancement New feature or request label Oct 10, 2024
Copy link
Collaborator

@the-mayer the-mayer left a comment

Choose a reason for hiding this comment

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

Thank you for this contribution, @awasyn! This rworkflows action will add many useful checks to the MolEvolvR 📦.

We plan to merge this PR eventually to benefit from CI, but currently, there are many simultaneous changes happening in the repository.

I’ve noted one change we should address in the interim. I’m not opposed to having this workflow manage building the pkgdown website, but at the moment, this check duplicates some functionality. I’d like your perspective on keeping the existing pkgdown action versus implementing the one in this PR.

@awasyn
Copy link
Collaborator Author

awasyn commented Oct 10, 2024

I’ve noted one change we should address in the interim. I’m not opposed to having this workflow manage building the pkgdown website, but at the moment, this check duplicates some functionality. I’d like your perspective on keeping the existing pkgdown action versus implementing the one in this PR.

I agree. The pkgdown in rworkflow can be on hold as It won't actually deploy since the checks are bound to fail as a result of incomplete function documentation.

Having the current pkgdown workflow is probably the best option to keep the site updated as changes are added.

@awasyn awasyn requested a review from the-mayer October 10, 2024 16:56
@jananiravi jananiravi added the outreachy for outreachy interns label Oct 20, 2024
@the-mayer the-mayer mentioned this pull request Oct 25, 2024
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request outreachy for outreachy interns
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants