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

build_news could optionally not add CRAN release date #1118

Closed
jangorecki opened this issue Aug 28, 2019 · 5 comments
Closed

build_news could optionally not add CRAN release date #1118

jangorecki opened this issue Aug 28, 2019 · 5 comments
Labels
feature a feature request or enhancement help wanted ❤️ we'd love your help! news 📰

Comments

@jangorecki
Copy link

Adding date to CRAN releases in while rendering news/index.html is a nice feature.
Yet if NEWS.md has already those dates in the content, then it makes that information duplicated.
One option is to remove dates from NEWS.md, so news/index.html will have only the one it produces. The downside of it is that readers of NEWS.md directly (not html on pkgdown website) won't have date information available.
Would be useful to have an option in yaml file to disable generation of those dates.

@hadley hadley added feature a feature request or enhancement help wanted ❤️ we'd love your help! news 📰 labels Aug 29, 2019
@MichaelChirico
Copy link
Contributor

As noted in this comment, there also seems to be an issue w parsing dates being handled inconsistently:

Rdatatable/data.table#3677 (comment)

Shall I file a separate issue for that?

@yiluheihei
Copy link
Contributor

Add a parameter directly in build_news(add_cran_date = TRUE)? And if the cran dates have been in NEWS.md, set the add_cran_date = FALSE to avoid building duplicated dates.

add_cran_date = TRUE
屏幕快照 2019-08-31 下午6 50 04

add_cran_date = FALSE
屏幕快照 2019-08-31 下午6 49 41

@hadley What about your opinion?

@hadley
Copy link
Member

hadley commented Aug 31, 2019

I think it's better to add parameters to the yaml (so the way pkgdown is run is captured by git), rather than the function.

@yiluheihei
Copy link
Contributor

yiluheihei commented Aug 31, 2019

sounds great, add parameter (e.g. add_cran_date) to _pkgdown_yml to control whether add cran date to the news/index.html

news: 
  - add_cran_date: TRUE

If it's ok, I'll create a pull request

@hadley
Copy link
Member

hadley commented Aug 31, 2019

Sounds good, thanks!

hadley added a commit that referenced this issue Mar 21, 2020
@hadley hadley closed this as completed in 81b292f Mar 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature a feature request or enhancement help wanted ❤️ we'd love your help! news 📰
Projects
None yet
Development

No branches or pull requests

4 participants