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

Initial contribution of dash-licenses-wrapper #1

Merged
merged 2 commits into from
Dec 7, 2023

Conversation

marcdumais-work
Copy link
Contributor

Description

This contribution provides a wrapper, to make it easier to integrate and run dash-licenses, in Eclipse Foundation projects repositories. It's mainly aiming to cover JavaScript and TypeScript projects, but might be usable in others too.

Once published to npm, the wrapper can be installed as a devDependency and used to run license checks locally on a developer's laptop and also as part of GitHub CI, using a provided example workflow file.

See README.md for more details

Testing

This contribution includes some minimal tests, run from a CI Tests GitHub workflow. There is a second 3PP License Check workflow that uses a trick to install the wrapper as a pseudo npm package and then run a license check, which gives a preview of what it will look-like when integrated to other projects/repos. Until this is published to npm, a similar trick could be used to install it temporarily, for a quick check.

I created a test PR on my fork so they would run. See the result of the workflow runs below:
CI Tests workflow
3PP License check workflow

Note: An earlier version of this contribution was first proposed as an addition to the dash-licenses repository but since there are no direct dependencies to that repo's content, it was deemed better to have it in on its own.

@waynebeaton
Copy link
Contributor

IP Review initiated: https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/11530

This contribution provides a wrapper, to make it easier to integrate and run
dash-licenses, in Eclipse Foundation projects repositories. It's mainly aiming
to cover JavaScript and TypeScript projects, but might be usable in others too.

Once published to `npm`, the wrapper can be installed as a devDependency and
used to run license checks locally on a developer's laptop and also as part
of GitHub CI, using a provided example `workflow` file.

See README.md for more details

Signed-off-by: Marc Dumais <[email protected]>
@marcdumais-work
Copy link
Contributor Author

Oops - there was a left-over mention of the secondary license, left from the original Theia sources - corrected now. Can you re-run Scancode?

Using the "Legal Documentation Generator" from the project dashboard.

Signed-off-by: Marc Dumais <[email protected]>
@marcdumais-work
Copy link
Contributor Author

@waynebeaton friendly ping :)

@waynebeaton waynebeaton merged commit a6a9bf3 into eclipse-dash:main Dec 7, 2023
@marcdumais-work marcdumais-work deleted the initial_contrib branch December 7, 2023 16:57
@marcdumais-work
Copy link
Contributor Author

@waynebeaton Any thoughts about how to proceed to publish this to npm? Does the project perhaps already have a npm organization or account?

If not, I could go ahead and create a free organization with an appropriate name (eclipse-dash?), temporarily add myself as a member and manually publish a first version of the package. Then, time permitting, I would try to figure-out automated publishing from CI if possible (from my fork first, where I can set GitHub secrets). In that scenario, I would plan to transfer ownership of the org to Webmaster, and let them manage it with the project's input. I have similarly transferred the Theia npm org a while ago. This approach would permit having this out ASAP and give me latitude to experiment with the automated publish setup, before handing-over the keys to the npm account.

However I am open to doing this however you think is best. WDYT?

@waynebeaton
Copy link
Contributor

I have no relevant experience in this matter.

It seems to me that the path that you've charted is our best bet.

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.

2 participants