Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updating the docs without publishing a release #867

Closed
2bndy5 opened this issue Sep 1, 2022 · 6 comments
Closed

updating the docs without publishing a release #867

2bndy5 opened this issue Sep 1, 2022 · 6 comments
Assignees

Comments

@2bndy5
Copy link
Member

2bndy5 commented Sep 1, 2022

I just had a thought that would allow us to publish docs without having to publish a release... It would involve a manually triggered the docs CI from the master branch (see workflow_dispatch event).

Of course this should be used lightly because the we don't want to publish docs that don't correspond to latest release.

@2bndy5 2bndy5 self-assigned this Sep 1, 2022
@2bndy5
Copy link
Member Author

2bndy5 commented Sep 1, 2022

RTD docs already do this:

  • "latest" = master's head
  • "stable" = latest tagged commit

image

Although, I'm not currently relying on RTD builds as a proper reference because the "Related Pages" have misplaced admonitions at the bottom (a bug in breathe).

@TMRh20
Copy link
Member

TMRh20 commented Sep 1, 2022

I think this would be a pretty good idea, there are probably lots of times the docs can be updated without a release being made, plus RPi/Linux users would be compiling from source in many cases. Thinking we should do this for all the RF24 repos.

@2bndy5
Copy link
Member Author

2bndy5 commented Sep 1, 2022

Thinking we should do this for all the RF24 repos.

Oops, I forgot to mention that was part of my intention.

2bndy5 added a commit that referenced this issue Sep 2, 2022
2bndy5 added a commit that referenced this issue Sep 2, 2022
@2bndy5
Copy link
Member Author

2bndy5 commented Sep 2, 2022

@TMRh20 @Avamander FYI
image

  1. select the docs CI workflow
  2. open the dropdown menu
  3. manually run the workflow on the master branch to update the docs.

Manually running this workflow on any other branch will not publish the docs (as usual).

@2bndy5 2bndy5 closed this as completed Sep 2, 2022
2bndy5 added a commit to nRF24/RF24Network that referenced this issue Sep 2, 2022
2bndy5 added a commit to nRF24/RF24Mesh that referenced this issue Sep 2, 2022
2bndy5 added a commit to nRF24/RF24Ethernet that referenced this issue Sep 2, 2022
2bndy5 added a commit to nRF24/RF24Gateway that referenced this issue Sep 2, 2022
@2bndy5
Copy link
Member Author

2bndy5 commented Sep 2, 2022

This wasn't needed for RF24Audio. If I missed a repo, let me know. The CirPy & pyRF24 repos already rely on RTD, so we don't need this for them either.

@TMRh20
Copy link
Member

TMRh20 commented Sep 2, 2022

Nice work!

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

No branches or pull requests

2 participants