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

Add macro do_readme_rmd() #223

Merged
merged 9 commits into from
Feb 23, 2020
Merged

Add macro do_readme_rmd() #223

merged 9 commits into from
Feb 23, 2020

Conversation

pat-s
Copy link
Member

@pat-s pat-s commented Jan 19, 2020

fixes #65

@pat-s pat-s added the feature label Jan 19, 2020
@pat-s pat-s requested a review from krlmlr January 19, 2020 21:51
krlmlr
krlmlr reviewed Jan 19, 2020
View reviewed changes
Copy link
Collaborator

@krlmlr krlmlr left a comment

Choose a reason for hiding this comment

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

Do we need to update long-form documentation?

Can we mark these macros as "experimental", with http://lifecycle.r-lib.org/?

R/macro-readme-rmd.R Outdated
#' @inheritParams step_setup_ssh
#' @inheritParams step_setup_push_deploy
#' @inheritParams step_do_push_deploy
#' @param path,branch By default, this macro deploys the `"master"` branch
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is gh-pages really an alternative?

Copy link
Member Author

Choose a reason for hiding this comment

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

Not really, thanks.

@pat-s
Copy link
Member Author

pat-s commented Jan 20, 2020

@krlmlr

  • Added a section about the macro to the "Getting started" vignette
  • added a lifecycle badge including the framework via usethis::use_lifecycle()

@pat-s
Copy link
Member Author

pat-s commented Feb 23, 2020

@krlmlr can we merge this?

krlmlr
krlmlr approved these changes Feb 23, 2020
View reviewed changes
Copy link
Collaborator

@krlmlr krlmlr left a comment

Choose a reason for hiding this comment

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

Looks good, thanks!

@pat-s pat-s merged commit eb36ca1 into master Feb 23, 2020
@pat-s pat-s deleted the macro-readme-rmd branch February 23, 2020 20:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@krlmlr krlmlr krlmlr approved these changes

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

Successfully merging this pull request may close these issues.

Add pkg documentation macro
2 participants
@pat-s @krlmlr