chore: filtering patches from docs deployment script#3779
Conversation
|
🚀 Deployed on https://657b908196878a0076966eda--noir-docs.netlify.app |
Likely a pagination issue on the github api due to the nightly releases. |
|
It only shows three versions, that's dev + 2... I think this is good this way, I believe there's no reason to support anything older than v17 |
|
No top level dependency changes detected. Learn more about Socket for GitHub ↗︎ |
The issue is that nightlies are pushing all of the stable releases out of the api response. As time goes on then we'll gradually get fewer and fewer versions showing up in the dropdown unless we release new breaking versions fast enough to ensure that we have 3 on the first page of the response from github. The way filtering is set up currently does "3 + dev" afaik as we're filtering the api response whereas dev gets added later by docusaurus. If you drop the limit down to 2 I expect that we'll get the same dropdown. |
|
+1 concern isn't on v0.10.5 specifically, but to make sure frequent nightlies / pre-releases would not affect versions available on docs. |
|
I'm sure it is getting pretty much all the versions, it does pagination but we get versions all the way back to 0.7ish iirc. It's the filtering that makes only the last 2 releases + dev show up 😊 but I can have a look tomorrow just to be sure before merging |
|
I only see releases back to 0.19.0 although this is just when opening up the endpoint in the browser so maybe if you're using an API key then you get more. |
|
So yeah seems like we're getting 100 versions per page, which is apparently not enough for 0.10.5. Here are all the versions pulled from the axios call: And this is after the first Had a quick look and indeed, versions like 0.15.0 are not stable. We also remove 0.16.0 manually for some reason I currently do not recall. That leaves us with these two. I'll make the change to pull more pages to filter, but I still believe it wouldn't be important to document anything below 0.17. Wdyt @Savio-Sou ? |
It had an unsafe merkle tree impl in the stdlib.
It's not so much that we need to go back to 0.10.5, the trouble is that going forwards in the best case scenario the longest time that we show docs for a particular minor version is around 3 months (before it's pushed off of the first page of the api response). I think that 3 months is a pretty short amount of time to display docs for a particular version. |
|
Makes sense 👍 Just updated the script to deal with 3 pages, which is enough to get ALL the versions since the beginning of time 💥
|
TomAFrench
left a comment
There was a problem hiding this comment.
Let's delete versions.json. Happy to merge once that's done.
2b2343c to
980ec38
Compare



Description
This change makes the script that runs before
yarn buildfilter down the patches to the latest patch of every major.Problem*
This script used to remove:
However, this would mean that every patch, as long as it was stable, would have its own docs deployed. This would lead to docs having three patch versions, which shouldn't even differ (they're patches, no breaking changes), like 0.19.1, 0.19.2, etc
Summary*
This change simplifies the script by removing some computation that was there just for debugging reasons. It also stops assuming all "aztec" versions are prereleases. And finally, it filters down only for the latest patch version.
Additional Context
Another way of doing it (which is how we're doing it now) is to just make all non-latest patch as prereleases, which is kinda annoying. With this change, it shouldn't matter.