search

BICCN / cell-locator

manually align specimens to annotated 3D spaces
https://cell-locator.readthedocs.io
Other
19 stars 7 forks source link

Documentation published on readthedocs is not current #219

Closed jcfr closed 1 year ago

jcfr commented 2 years ago

Description

Documentation published at https://cell-locator.readthedocs.io/ is not automatically updated after pushing or integrating changes to the master branch.

After browsing to https://readthedocs.org/projects/cell-locator/ the following is reported:

image

Clicking on the GitHub incoming webhook link seems to correctly indicate that the payloads are received ....

image

... that said the build are not started automatically

image

Attempting to address this by clicking on Resync webhook leads to the following:

image

Expected behavior

Automatic rebuild of the documentation.

How to Reproduce

Integrate a pull request and/or directly push changes to the master branch.

jcfr commented 2 years ago

@lydiang Assuming you have admin access to BICCN GitHub organization, could you help with re-syncing the readthedocs webhook ?

cc: @allemangD

allemangD commented 1 year ago

Discovered the issue is because rtd pulls the latest tag which had been set to 40e28bf0c422ac1a23896dad0440ea345f5c3cfb with no automation to update it.

I've updated that tag to the current master - see https://github.com/BICCN/cell-locator/commits/latest - but we should look into having rtd pull a more appropriate branch, or set up automation to update latest after releases.

jcfr commented 1 year ago

I've updated that tag to the current master

Thanks, inspecting the settings confirms this:

image

we should look into having rtd pull a more appropriate branch, or set up automation to

Ditto. Since we already a webhook in place, build should happen automatically. I will confirm this by pushing (and then reverting) a commit to master.

image

jcfr commented 1 year ago

After pushing to master:

GitHub hook delivery Readthedocs received payload
image image
image
jcfr commented 1 year ago

Even after modifying a documentation file, the build is not triggered.

For sake of comparison:

Slicer Cell Locator
image image
jcfr commented 1 year ago

Solution:

  1. Make sure the default version in Advanced Settings is not "latest"
  2. Deactivate latest in the versions list
  3. Activate master
  4. Go back to Advanced Settings and set default version as master, and default branch as latest
Versions Advanced Settings
image image

For comparison, here it the Advanced Settings before and after:

Before After
image image
jcfr commented 1 year ago

It turns out that the following sequence worked:

  1. Go to Advanced Settings, select something different from "Default version" (latest) and "Default branch" (master)
  2. Go back to "Versions", and deactivate all version except the one selected in prevous step, then re-activate "latest"
  3. Go back to Advanced Settings, select "Default version" (latest) and "Default branch" (master)

image

jcfr commented 1 year ago

@lydiang I just sent a request for adding the Read the Docs OAuth App to the BICCN organization. When you have a chance, could you accept it ?

https://github.com/settings/connections/applications/fae83c942bc1d89609e2
image
lydiang commented 1 year ago

approval done

From: Jean-Christophe Fillion-Robin @.> Sent: Wednesday, November 30, 2022 10:20 PM To: BICCN/cell-locator @.> Cc: Lydia Ng @.>; Mention @.> Subject: Re: [BICCN/cell-locator] Documentation published on readthedocs is not current (Issue #219)

@lydianghttps://nam12.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Flydiang&data=05%7C01%7C%7Cc15390ff95a945f124c808dad36433a0%7C32669cd6737f4b398bddd6951120d3fc%7C0%7C0%7C638054724604010886%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=iEVubMiQKbRr2%2FB5pwmgCqEohaAHxsb2WSLXkyWL%2Bdo%3D&reserved=0 I just sent a request for adding the Read the Docs OAuth Apphttps://nam12.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fsettings%2Fapplications&data=05%7C01%7C%7Cc15390ff95a945f124c808dad36433a0%7C32669cd6737f4b398bddd6951120d3fc%7C0%7C0%7C638054724604010886%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=%2B7R8wDz%2BTNVij1Z%2Fub2KQD45REV6ksomxOZSRrR3W4c%3D&reserved=0 to the BICCN organization. When you have a chance, could you accept it ?

https://github.com/settings/connections/applications/fae83c942bc1d89609e2https://nam12.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fsettings%2Fconnections%2Fapplications%2Ffae83c942bc1d89609e2&data=05%7C01%7C%7Cc15390ff95a945f124c808dad36433a0%7C32669cd6737f4b398bddd6951120d3fc%7C0%7C0%7C638054724604010886%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=Io7KRRDAJwSnkM8d0lWu6VuPcrH5BjIfkf2I0fBgkz0%3D&reserved=0 [image]https://nam12.safelinks.protection.outlook.com/?url=https%3A%2F%2Fuser-images.githubusercontent.com%2F219043%2F204980115-43e8f366-ea30-4f4f-bbfc-136247857bbe.png&data=05%7C01%7C%7Cc15390ff95a945f124c808dad36433a0%7C32669cd6737f4b398bddd6951120d3fc%7C0%7C0%7C638054724604010886%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=ILIdF4kCU9y1YfRRI2%2B%2FWj2SDgVDloe54hVymxJUYXY%3D&reserved=0

— Reply to this email directly, view it on GitHubhttps://nam12.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FBICCN%2Fcell-locator%2Fissues%2F219%23issuecomment-1333270362&data=05%7C01%7C%7Cc15390ff95a945f124c808dad36433a0%7C32669cd6737f4b398bddd6951120d3fc%7C0%7C0%7C638054724604010886%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=UExU7Qz7SNbjRFwc7AjUTMrYX06yEe8PDdNLTJ5X99o%3D&reserved=0, or unsubscribehttps://nam12.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FACBIBYI5XRHXDZ7BDLNIMTLWLA7ULANCNFSM55IG6JXA&data=05%7C01%7C%7Cc15390ff95a945f124c808dad36433a0%7C32669cd6737f4b398bddd6951120d3fc%7C0%7C0%7C638054724604010886%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=WxmlrVFPgVhnRiMhWZcPFGAwJ0MJYbeNWziaZ%2BGqRNw%3D&reserved=0. You are receiving this because you were mentioned.Message ID: @.***>

jcfr commented 1 year ago

Thanks @lydiang ,the webhook has now been added/re-synced.

image

image

Support for building preview of the documentation in pull-request also enabled :rocket:

image

jcfr commented 1 year ago

@allemangD I just realized that we have a tag named latest and this is likely what is confusing the system.
image image

I will deleted the tag.

jcfr commented 1 year ago

After deleting the tag, readthedocs now show main:

image