DISCUSS - `0.17.0` Release

[trallard]

It has been over three months since our last release, and a good number of enhancements and bug fixes have been added since then. I believe we are in a good place to think about making a new release.

Also, having a new release should help fix #2088

I also want to get #2159 in this upcoming release, as the current version breaks some stuff for downstream projects.

cc/ @gabalafou @drammock

[drammock]

potential blockers:

• there are a couple bugs noticed on [ENH] Implement new scrollspy #2119 that should probably get addressed before a release.
• Don't show toctree hidden pages in left nav sidebar #2168 looks like a moderately bad bug, if it can be reproduced

Less urgent but worth considering:

• linkcheck is still failing (e.g. on Updates for file src/pydata_sphinx_theme/locale/en/LC_MESSAGES/sphinx.po in ca #2177) even after MAINT - Workflows updates #2174 was merged
• Allow gitlab URL link shortening from non-gitlab/github.com domains #2068 and Make icon links and link shortening optional #2109 both deal with link shortening and have been sitting for a while

I think next release should be 0.17.0, the scrollspy and search-as-you-type changes are big ones.

[trallard]

I think next release should be 0.17.0, the scrollspy and search-as-you-type changes are big ones.

You are right, I agree this would be more like 0.17.0

⛔ Blockers:

there are a couple bugs noticed on #2119 that should probably get addressed before a release.

We should look into this (cc @gabalafou @peytondmurray).

I was not counting this feature in the upcoming release due to this comment from @gabalafou

there are a couple bugs noticed on [ENH] Implement new scrollspy #2119 that should probably get addressed before a release.

ref: #2119 (comment)

But since it is merged now, we should look into fixing the issues.

Tracking in #2178

---

🐛 Non-blockers, but would be nice to look into:

linkcheck is still failing (e.g. on #2177) even after #2174 was merged

I looked at the fail you mentioned in another PR, which seems new. I will see if I can reproduce it. However, I re-ran the workflow and the gnu fail is back, so I might add that URL to the ignore list

[gabalafou]

By the way, I think #2185 fixes the blocking scroll spy issues

[trallard]

We still have some small tweaks I need to make to our CI. I started them but have been swamped these past weeks, I will prioritise that next week so we can move towards a new release.

[gabalafou]

@trallard and I were discussing the release the other day. Concerning the following two issues:

1. Allow gitlab URL link shortening from non-gitlab/github.com domains #2068
2. Make icon links and link shortening optional #2109

We think we should push the first one to a later release because it is a big refactor of the version control link shortening code. And because we want to push the first one, we think we should include the second one. I suspect that part of the motivation of the second PR, to provide a way to turn off link shortening, has to do with the ways it overreaches, which the first PR addresses. So until the first PR is merged, we should support a way to turn off link shortening.

Does that reasoning work for others? cc @drammock

Edit: I still plan to add a test to #2109. I should have that done today.

[drammock]

Does that reasoning work for others?

SGTM