Skip to content

Conversation

@cicdguy
Copy link
Contributor

@cicdguy cicdguy commented Jan 6, 2025

Reintroduces the multiversion docs feature per @manciniedoardo's request.

The change was reverted in ee3e5b1 per @pharmaverse/admiral's decision.

This PR will reintroduce multiversion docs.

See examples where this is successfully used:

@cicdguy cicdguy self-assigned this Jan 6, 2025
@cicdguy cicdguy requested a review from jeffreyad as a code owner January 6, 2025 13:40
@cicdguy cicdguy force-pushed the feat/reintroduce-multiversion-docs branch from 6aacbbd to 859172d Compare January 6, 2025 13:41
@cicdguy
Copy link
Contributor Author

cicdguy commented Jan 6, 2025

Weird - I don't see a "draft" option for this PR, maybe because pharmaverse is a free-tier GitHub org.

@cicdguy cicdguy changed the title feat: Reintroduce multiversion docs DRAFT: feat: Reintroduce multiversion docs Jan 6, 2025
@github-actions
Copy link

github-actions bot commented Jan 6, 2025

Code Coverage

Package Line Rate Health
admiral 98%
Summary 98% (5519 / 5631)

Copy link
Collaborator

@bms63 bms63 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @cicdguy!! Shall I merge this in now?

We have a new CRAN release on Jan 15 be great to work out any kinks before that

@cicdguy
Copy link
Contributor Author

cicdguy commented Jan 6, 2025

Thanks @cicdguy!! Shall I merge this in now?

We have a new CRAN release on Jan 15 be great to work out any kinks before that

Not yet - I'll need to push the past versions into the gh-pages branch. Also I'll do a full check regarding link updates across other repos as they may be referring to admiral articles whose URLs will change as a result of this.

@cicdguy cicdguy changed the title DRAFT: feat: Reintroduce multiversion docs DRAFT - DO NOT MERGE ⚠️ feat: Reintroduce multiversion docs Jan 6, 2025
@bms63
Copy link
Collaborator

bms63 commented Jan 6, 2025

Thanks @cicdguy!! Shall I merge this in now?
We have a new CRAN release on Jan 15 be great to work out any kinks before that

Not yet - I'll need to push the past versions into the gh-pages branch. Also I'll do a full check regarding link updates across other repos as they may be referring to admiral articles whose URLs will change as a result of this.

Roger! I guess that is why you wanted to set it to DRAFT! Just ping me if you want a second set of eyes or to merge in. Thanks again for making this update - I know you are in high demand!

@cicdguy
Copy link
Contributor Author

cicdguy commented Jan 10, 2025

I'll revisit this after the upcoming release. Do not want to disrupt anything that way.

@github-actions
Copy link

This Pull Request is stale because it has not been worked on in 15 days.

@github-actions github-actions bot added the stale label Jan 26, 2025
@bms63
Copy link
Collaborator

bms63 commented Jan 26, 2025

@cicdguy think we can proceed with this PR now. admiral was released on January 15th with no issues identified...so far.

@bms63
Copy link
Collaborator

bms63 commented Jan 26, 2025

Will the links not be an issue once this is merged into main - the ones with cran-release are all failing.

@github-actions github-actions bot removed the stale label Jan 27, 2025
@cicdguy
Copy link
Contributor Author

cicdguy commented Jan 30, 2025

@bms63 - yes those links will all be updated. There's some other background work required to finish this end-to-end (re-provisioning older version on gh-pages etc), so I'll keep this open until that other work has also been completed.

@manciniedoardo
Copy link
Collaborator

Update from @cicdguy: progress on this expected by end of month

@github-actions
Copy link

This Pull Request is stale because it has not been worked on in 15 days.

@github-actions github-actions bot added the stale label Feb 23, 2025
@github-actions github-actions bot removed the stale label Apr 1, 2025
@github-actions
Copy link

This Pull Request is stale because it has not been worked on in 15 days.

@github-actions github-actions bot added the stale label Apr 17, 2025
@github-actions github-actions bot removed the stale label May 23, 2025
@manciniedoardo
Copy link
Collaborator

@cicdguy now that docs are built successfully, i guess this is almost done? 🙏

@cicdguy cicdguy changed the title DRAFT - DO NOT MERGE ⚠️ feat: Reintroduce multiversion docs feat: Reintroduce multiversion docs May 25, 2025
@cicdguy
Copy link
Contributor Author

cicdguy commented May 25, 2025

Almost ready to go. Just need to resolve an issue with Staged Dependencies for tag-based events.

@manciniedoardo
Copy link
Collaborator

@cicdguy how is this going?

@cicdguy
Copy link
Contributor Author

cicdguy commented Jun 2, 2025

Going good. Tests are running fine. We should be good to merge.

@manciniedoardo
Copy link
Collaborator

manciniedoardo commented Jun 2, 2025

Ok I'll resolve the conflicts and merge tomorrow if no other comments!

Edit: conflicts already resolved

@manciniedoardo
Copy link
Collaborator

Thanks @cicdguy 😄

@cicdguy
Copy link
Contributor Author

cicdguy commented Jun 2, 2025

Ok I'll resolve the conflicts and merge tomorrow if no other comments!

Oh snap. I resolved it (I think).

@manciniedoardo
Copy link
Collaborator

Hmm coverage still unhappy :(

@cicdguy
Copy link
Contributor Author

cicdguy commented Jun 2, 2025

Darn, let me fix that.

@manciniedoardo
Copy link
Collaborator

not sure if it's you, seeing it on other PRs

@cicdguy
Copy link
Contributor Author

cicdguy commented Jun 2, 2025

Yeah it's my bad. Need to fix

@cicdguy cicdguy force-pushed the feat/reintroduce-multiversion-docs branch from 3eff678 to ca8f9b6 Compare June 2, 2025 17:32
@cicdguy
Copy link
Contributor Author

cicdguy commented Jun 2, 2025

Ok should be fixed now.

@bms63 bms63 requested review from bms63 and manciniedoardo June 2, 2025 17:45
@bms63
Copy link
Collaborator

bms63 commented Jun 2, 2025

Ok should be fixed now.

okay to merge this in? we still will have dev version of site?

@cicdguy
Copy link
Contributor Author

cicdguy commented Jun 2, 2025

Yes. Exactly

@bms63
Copy link
Collaborator

bms63 commented Jun 2, 2025

@cicdguy thanks again!!!

@bms63 bms63 merged commit 52354dc into main Jun 2, 2025
19 checks passed
@bms63 bms63 deleted the feat/reintroduce-multiversion-docs branch June 2, 2025 17:53
@bms63
Copy link
Collaborator

bms63 commented Jun 3, 2025

@cicdguy any chance we can not have .9000 appear as version?

image

@cicdguy
Copy link
Contributor Author

cicdguy commented Jun 3, 2025

Yes, change your tag/DESCRIPTION to the correct version: https://github.com/pharmaverse/admiral/blob/v1.2.0/DESCRIPTION#L4

v1.2.0 has 1.2.0.9000 in the DESCRIPTION file :)

@bms63
Copy link
Collaborator

bms63 commented Jun 3, 2025

ah darn that is on me then. ummm..

@bms63
Copy link
Collaborator

bms63 commented Jun 3, 2025

alright fixed up
image

@bundfussr
Copy link
Collaborator

alright fixed up image

@bms63 , I think there went something wrong. The older versions were removed and the cran-release folder was removed from the gh-pages branch. This causes the link checker to fail (see https://github.com/pharmaverse/admiral/actions/runs/15443291847/job/43466150660?pr=2754).

@bms63
Copy link
Collaborator

bms63 commented Jun 4, 2025

@cicdguy could we get some pointers? I just modified the tag-v1.2.0 and then did a re-release on the updated tag.

@bms63
Copy link
Collaborator

bms63 commented Jun 4, 2025

image

@cicdguy
Copy link
Contributor Author

cicdguy commented Jun 4, 2025

Ouch. Yeah that's bad. I'll look into it next week or so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants