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

Library does not appear in Contributions Manager #60

Open
alexdmiller opened this issue Nov 25, 2024 · 5 comments
Open

Library does not appear in Contributions Manager #60

alexdmiller opened this issue Nov 25, 2024 · 5 comments
Labels
question Further information is requested

Comments

@alexdmiller
Copy link
Contributor

Describe the bug

After running deployToProcessingSketchbook and confirming that the library has been added to Processing/libraries, the new library does not appear in the Contributions Manager. However, it does appear in the Sketch > Import Library... menu:

Screen Shot 2024-11-25 at 12 38 19 PM

Steps to reproduce

  1. Run deployToProcessingSketchbook
  2. Go to Sketch > Import Library... > Manage Libraries
  3. Search for "A Template Example Library"

Expected behavior

It should appear in the list

Actual behavior

It does not appear

@alexdmiller alexdmiller added the bug Something isn't working label Nov 25, 2024
@SableRaf
Copy link
Collaborator

Hi @alexdmiller, thanks for your question!

The deployToProcessingSketchbook script adds your library locally but doesn’t list it in the Contribution Manager. The Contributions Manager only includes libraries that have been officially submitted and approved.

To have your library appear there, email [email protected] with the URL to your GitHub releases page (e.g., https://github.com/{{username}}/{{repository}}/releases/).

You can find more instructions on releasing libraries here.

Let me know if you have any questions about the process! 😊

@SableRaf SableRaf added question Further information is requested and removed bug Something isn't working labels Nov 26, 2024
@alexdmiller
Copy link
Contributor Author

That makes sense. I believe the documentation is wrong then. The section titled "Testing the Library Template" in the Getting Started guide says:

  1. Check if the library appears in the Contribution Manager:
  2. Open Processing, and click on Sketch > Import Library ... > Manage Libraries .... This opens the Contribution Manager.
  3. You should see an entry named "A Template Example Library" with a check mark next to it. This is the sample library you just installed using the template.
  4. If it does not appear, please check the troubleshooting guide.

If you agree, would you like me to open a PR to correct the documentation?

@SableRaf
Copy link
Collaborator

Hmm maybe I misspoke then 🤔 Let's see what @mingness has to say about this.

@mingness
Copy link
Collaborator

Looks like there is a dependence on OS on how the new library appears. Let me research this further. Thanks again for bringing this to our attention.

@mingness
Copy link
Collaborator

Hello @alexdmiller , thanks for your offer to provide a fix. Looking into the situation, it seems the current text of the documentation is only valid for Linux. Both Windows and Mac behave the way you've observed. Would you be willing to edit the documentation to reflect this situation? Apologies for the slow response - I hope you still have time for this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants