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

Source code release zip is mostly empty directories. #450

Closed
clickonben opened this issue Dec 17, 2023 · 6 comments · Fixed by adafruit/adabot#367
Closed

Source code release zip is mostly empty directories. #450

clickonben opened this issue Dec 17, 2023 · 6 comments · Fixed by adafruit/adabot#367
Assignees

Comments

@clickonben
Copy link

The source code .zip and .tar.gz files that get produced as part of each release have an empty directory structure in the "libraries" directory, there is no code at all. It looks like whatever builds these doesn't properly process the git submodules so anything that is a submodule is just an empty directory in both zips.

@FoamyGuy
Copy link
Contributor

This is the link to use for the python source code for all libraries in the bundle
image

It looks populated correctly as far as I can tell. I don't believe the links below are intended to have things in them, but I'm not certain.

@clickonben
Copy link
Author

So what you are saying is that the files named "source code" don't contain much if any source code and are supposed to be mostly just empty directories?

Assuming there is some purpose to these files that escapes me, I would politely suggest that they are renamed or at least an explanation is added to the download page that the archive files that are labelled "source code" aren't the ones that contain the source code.

@FoamyGuy
Copy link
Contributor

I think the links for Source Code zip and tar.gz are created automatically by Github and it seems that they are known to not populate code for submodules based on the discussion here: softprops/action-gh-release#220

I didn't dig too deep but it after a quick look it doesn't seem possible to disable them or rename the links to something different unfortunately. Perhaps we can try to come up with some clarifying language to add to the release notes.

@jepler
Copy link
Member

jepler commented Dec 18, 2023

I want to confirm what @FoamyGuy says -- as far as I know there is no way to remove or suppress the "source code (zip)" or "source code (tar.gz)" links that are automatically added by github, and there's no way to make them include the content of the files that are actually used to build the bundle.

If there's something actionable about this for us, it could be to add a note in the standard release notes that says that due to github technical limitations those links are not useful. Otherwise, there does not seem to be much that we can do.

@dhalbert
Copy link
Contributor

I was looking for the standard release notes template, but could not immediately find where they came from, even with GitHub organization search. I agree that's what's to be done here. I did something similar in the release notes for adafruit/circuitpython.

@jepler
Copy link
Member

jepler commented Dec 18, 2023

It looks like the text we use comes from adabot

adabot/circuitpython_bundle.py:        " Please download the one that matches the major version of your CircuitPython. For example"

@jepler jepler self-assigned this Dec 18, 2023
jepler added a commit to jepler/adabot that referenced this issue Dec 18, 2023
 * Suggest use of circup
 * Mention to use bundle-py not 'source code'

Closes: adafruit/Adafruit_CircuitPython_Bundle#450
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 a pull request may close this issue.

4 participants