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

actions: vendor sources with submodules for releases #4668

Merged
merged 1 commit into from
Oct 21, 2024

Conversation

widlarizer
Copy link
Collaborator

@widlarizer widlarizer commented Oct 16, 2024

We like submodules for SBOM reasons and prefer them over in-repo vendored libraries. However this creates a burden on users with needs for gitless workflows who have to take our (yosys) source tarball, drop in our other (yosys-abc) source tarball, manually check submodules versions at the git tag, download those, and only then build yosys. An alternate solution is to add Makefile targets like curl-abc #4472 but that needs per-submodule work. This PR adds a workflow which on main commits creates a source tarball artifact including submodule sources

  • instruct users of vendored dependencies that licenses in abc/ and libs/* apply to those components
  • eliminate zeroes that prevent libs/cxxopts from being visible

@widlarizer widlarizer requested a review from mmicko as a code owner October 16, 2024 08:32
@widlarizer widlarizer force-pushed the emil/vendor-submodules branch 3 times, most recently from c1744b0 to cf4af96 Compare October 16, 2024 15:15
with:
name: vendored-sources
path: yosys-src-vendored.tar.gz
retention-days: 1
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the idea here to replace the current ABC tarball with this combined tarball for inclusion in release?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know, but the availability of an all-inclusive tarball is kind of orthogonal to whether there is still a need to provide yosys-abc seperately in the yosys repo

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess the replacement is less what I was asking, and more is retention-days: 1 because the intention is for it to be added to releases, as opposed to being generally available for the most recent commit

Copy link
Collaborator Author

@widlarizer widlarizer Oct 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, 1 because the intention is to be added to releases. My intention is to be able to run it manually actually, so:

  • re-add workflow_dispatch

@widlarizer widlarizer force-pushed the emil/vendor-submodules branch from 1143d67 to d29499a Compare October 16, 2024 22:11
@widlarizer widlarizer added the merge-after-jf Merge: PR will be merged after the next Dev JF unless concerns are raised label Oct 17, 2024
@widlarizer widlarizer merged commit c1907ef into main Oct 21, 2024
41 checks passed
@mmicko mmicko deleted the emil/vendor-submodules branch October 21, 2024 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge-after-jf Merge: PR will be merged after the next Dev JF unless concerns are raised
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants