search

TileDB-Inc / tiledbsoma-feedstock

A conda-smithy repository for tiledbsoma.
BSD 3-Clause "New" or "Revised" License
3 stars 3 forks source link

Add back top-level about section (required for rerendering) #27

Closed jdblischak closed 1 year ago

jdblischak commented 1 year ago

In PR #24, I removed the top-level about section in favor of separate about sections per output. This added some redundancy (which we could probably solve with some YAML/jinja2 hacking if we really wanted to), but had the big benefit of having accurate summary and description sections on anaconda.org.

While the top-level about section isn't required for conda, it is required by conda smithy rerender to populate the README. This is why the nightly builds are currently failing, eg build #58 from 2 days ago.

Note that the README rendering for a recipe with multiple outputs is rather unfortunate. There is no newline between the description of the previous output and the title of the next output section, so the whole description is formatted as a header. I tried some quick hacks, eg adding \n to the description, but nothing worked. This appears to happen for all recipes with multiple outputs, eg https://github.com/conda-forge/arrow-cpp-feedstock#readme. I'll take a quick look at conda-smithy to see if there is a quick fix

Please feel free to suggest changes to the summary and descriptions

Also note that I purposefully did not bump the build number. This PR only affects the feedstock and not the builds, so there is no reason to waste storage space by uploading new binaries.

jdblischak commented 1 year ago

Update: sent a PR upstream to fix the README headers for recipes with multiple outputs

https://github.com/conda-forge/conda-smithy/pull/1739

jdblischak commented 1 year ago

I confirmed that the nightly builds are once again passing

https://github.com/TileDB-Inc/tiledbsoma-feedstock/actions/runs/5217473834 https://github.com/TileDB-Inc/tiledbsoma-feedstock/tree/nightly-build

jdblischak commented 1 year ago

Update: sent a PR upstream to fix the README headers for recipes with multiple outputs

Good news: My PR https://github.com/conda-forge/conda-smithy/pull/1739 was merged! Bad news: we have to wait until the next release of conda-smithy before rerendering will fix the README formatting