Skip to content

Add a workflow to generate folder images #1533

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

Merged
merged 1 commit into from
May 4, 2021
Merged

Conversation

jepler
Copy link
Contributor

@jepler jepler commented May 4, 2021

This workflow will generate a bunch of images and place them on a branch called "folder-images", which (once enabled via github pages) will appear on adafruit.github.io.

The workflow is triggered:

  • on commits to the main branch, including merged pull requests
  • daily, after the bundle is updated
  • on request via the github web page

Typically, this means that the images will be available (well) within an hour after a pull request is merged, and will be updated daily if required by changes to the requirements of libraries.

There is an HTML index by name, to make it "easier" to find the relevant image.

Here is the site generated under my personal github pages: http://www.unpythonic.net/Adafruit_Learning_System_Guides/

Index:
image

Typical image (from http://www.unpythonic.net/Adafruit_Learning_System_Guides/BLE_Client_Server.png):

image

This workflow will generate a bunch of images and place them on a branch called
"folder-images", which (once enabled via github pages) will appear on
adafruit.github.io.

The workflow is triggered:
 * on commits to the main branch, including merged pull requests
 * daily, after the bundle is updated
 * on request via the github web page

Typically, this means that the images will be available (well) within an hour
after a pull request is merged, and will be updated daily if required by
changes to the requirements of libraries.
@jepler jepler requested a review from ladyada May 4, 2021 16:38
@ladyada
Copy link
Member

ladyada commented May 4, 2021

lets see what happens next!

@jepler jepler merged commit c517263 into adafruit:master May 4, 2021
@ladyada
Copy link
Member

ladyada commented May 4, 2021

please make the path include subfolders since some folders have multiple code exmaples in them, @kattni wrote some recently

@FoamyGuy
Copy link
Collaborator

FoamyGuy commented May 4, 2021

@ladyada you mean have it show the contents of the subfolders in the images?

@ladyada
Copy link
Member

ladyada commented May 4, 2021

nono like sometimes there are multiple subfolders with code.py in them, like
https://github.com/adafruit/Adafruit_Learning_System_Guides/tree/master/QT_Py_RP2040
which means we need two images and also the names should not conflict

@FoamyGuy
Copy link
Collaborator

FoamyGuy commented May 5, 2021

Ah I see. it will make to images:

QT_Py_RP2040_digital_input_neopixel.png
QT_Py_RP2040_neopixel_rainbow.png

each one showing the libraries for the code.py that is inside of its folder.

@ladyada
Copy link
Member

ladyada commented May 5, 2021

oh ok it does that now? gr8

@FoamyGuy
Copy link
Collaborator

FoamyGuy commented May 5, 2021

No, sorry, I meant that is how we want it to behave.

I will work on making that change though. I think I can make it work like that.

@ladyada
Copy link
Member

ladyada commented May 5, 2021

oh ha - yah sorry thats right!

@jepler
Copy link
Contributor Author

jepler commented May 5, 2021

@ladyada this has now been added

image

@ladyada
Copy link
Member

ladyada commented May 5, 2021

ok yay

@jepler jepler deleted the master branch October 13, 2021 13:50
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.

3 participants