bioio icon indicating copy to clipboard operation
bioio copied to clipboard

generated docs are getting wrong version number

Open toloudis opened this issue 1 year ago • 5 comments

Describe the Bug

generated docs are getting wrong version number

Expected Behavior

generated docs are getting right version number

Reproduction

https://bioio-devs.github.io/bioio/OVERVIEW.html

toloudis avatar Jul 22 '24 22:07 toloudis

@evamaxfield do you know what is going on here?

BrianWhitneyAI avatar Jul 25 '24 19:07 BrianWhitneyAI

I believe I do but I'll take a look later today!

evamaxfield avatar Jul 25 '24 19:07 evamaxfield

amazing thank you! My thoughts are that during the docs build the distribution isnt built/accessible so bioio.__version__ which uses version(bioio) cannot read the version and just makes a low level dev version. not sure how to fix though...

BrianWhitneyAI avatar Jul 25 '24 19:07 BrianWhitneyAI

Seems like docs still have incorrect version. I will make a new PR to keep testing things out and I will make the docs job run on pushes to the branch so that I can iteratively test. Ultimately though, seems like we may just want to change this job to only run on tag releases so a little bit of both understanding what is going on and fixing it seems likely.

evamaxfield avatar Jul 29 '24 18:07 evamaxfield

yes please -- https://github.com/bioio-devs/bioio/pull/64#issuecomment-2254626666

toloudis avatar Jul 29 '24 18:07 toloudis

Bump! Sometimes we want to link to the docs for very new users and it looks bad if the version number is still some early dev prerelease build.

toloudis avatar Sep 11 '24 23:09 toloudis

ugh. sorry. i continue to just be busy. i think the fix for this is to move the docs to build on each release rather than build on push to main.

evamaxfield avatar Sep 11 '24 23:09 evamaxfield