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 needs specially formatted NEWS.md #1947

Closed
rmflight opened this issue Dec 3, 2021 · 9 comments · Fixed by #1967
Closed

build_news needs specially formatted NEWS.md #1947

rmflight opened this issue Dec 3, 2021 · 9 comments · Fixed by #1967
Labels
bug an unexpected problem or unintended behavior news 📰
Milestone

Comments

@rmflight
Copy link

rmflight commented Dec 3, 2021

In pkgdown 1.6.1, build_news rendered fine with any kind of heading. As in I could have NEWS.md containing:

# v 0.0.2

* more bugs!

# v 0.0.1

* bugs fixed

However, as of v 2.0.1, that seems to have changed. The above contents in NEWS.md will render an empty page. Instead, it has to be formatted like this in NEWS.md:

# packageName 0.0.2

* more bugs!

# packageName 0.0.1

* bugs fixed

I'm not sure how many other people were using a simpler format of NEWS.md as I was, but it would be nice if the docs or vignette for bulid_news had more information on the required formatting.

maelle added a commit to ropensci/jsonvalidate that referenced this issue Dec 14, 2021
@maelle
Copy link
Collaborator

maelle commented Dec 14, 2021

What also doesn't work is having all h2. Maybe it should work.

@maelle
Copy link
Collaborator

maelle commented Dec 14, 2021

#1967

@Al-Murphy
Copy link

Hey! I ran into what I think is the same issue with a GHA check on my Bioconductor R package: https://github.com/neurogenomics/MungeSumstats/runs/4522582120?check_suite_focus=true

Is a fix likely to be released soon or is there a work around for time being? I'm constricted since Bioconductor enforces standards on the NEWS file

@kevinushey
Copy link
Contributor

I ran into this too with reticulate: https://raw.githubusercontent.com/rstudio/reticulate/main/NEWS.md

> pkgdown::build_news()
-- Building news ----------------------------------------------------------------------
Error: Invalid NEWS.md: bad nesting of titles

Presumedly because these are H2 rather than H1 headers.

@privefl
Copy link
Contributor

privefl commented Feb 17, 2022

I'm having a similar issue, where some headers do not render.

E.g. https://github.com/privefl/bigsnpr/blob/e72fa27b7bb4486b542505c46454ffcd21e5fa18/NEWS.md?plain=1#L71-L73 in https://github.com/privefl/bigsnpr/blob/e72fa27b7bb4486b542505c46454ffcd21e5fa18/docs/news/index.html#L155-L160.

Problem is still there after updating to latest GitHub version of {pkgdown}.

@maelle
Copy link
Collaborator

maelle commented Feb 17, 2022

@privefl that header is for "bigsparser" but the package is "bigsnpr" hence its not being recognized.

Side note: in general it's better to open a new issue.

@privefl
Copy link
Contributor

privefl commented Feb 17, 2022

Yes, but I also want to show some important new releases from another package, of which my package is very dependent on.

This was working with v1.6.1.

@privefl
Copy link
Contributor

privefl commented Oct 12, 2022

Should I expect this not to be fixed? (i.e. working as with v1.6.1)

@hadley
Copy link
Member

hadley commented Oct 12, 2022

@privefl you seem to expect a special case that was only ever supported by accident and we don’t plan to support going forward.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug an unexpected problem or unintended behavior news 📰
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants