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

chore: include NOTICE file in npm published package and in dist #2764

Merged
merged 6 commits into from
Jun 16, 2022

Conversation

trentm
Copy link
Member

@trentm trentm commented Jun 9, 2022

The NOTICE file in the distribution includes the license for all
the bundled packages (i.e. add dependencies, excluding devDependencies).

Creating the distribution (dev-utils/make-distribution.sh) will fail
if one of the deps has no license or an unknown license.

The NOTICE file in the distribution includes the license for all
the bundled packages (i.e. add dependencies, excluding devDependencies).

Creating the distribution (dev-utils/make-distribution.sh) will fail
if one of the deps has no license or an unknown license.
@trentm trentm requested a review from astorm June 9, 2022 23:25
@trentm trentm self-assigned this Jun 9, 2022
@github-actions github-actions bot added the agent-nodejs Make available for APM Agents project planning. label Jun 9, 2022
@elastic-apm-tech elastic-apm-tech added this to In Progress in APM-Agents (OLD) Jun 9, 2022
@trentm
Copy link
Member Author

trentm commented Jun 9, 2022

Here is an example generated NOTICE file: https://gist.github.com/trentm/057ec6b14669a6b02562581756a362d9
It is the current NOTICE.md with the generated part below: https://gist.github.com/trentm/057ec6b14669a6b02562581756a362d9#notice-for-distributed-packages

@apmmachine
Copy link
Collaborator

apmmachine commented Jun 9, 2022

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-06-14T20:01:35.316+0000

  • Duration: 20 min 8 sec

Test stats 🧪

Test Results
Failed 0
Passed 258073
Skipped 0
Total 258073

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • run module tests for <modules> : Run TAV tests for one or more modules, where <modules> can be either a comma separated list of modules (e.g. memcached,redis) or the string literal ALL to test all modules

  • run benchmark tests : Run the benchmark test only.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

Copy link
Contributor

@astorm astorm left a comment

Choose a reason for hiding this comment

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

Looks good -- one question on case sensitivity and I think we'll be good to go.

dev-utils/gen-notice.sh Outdated Show resolved Hide resolved
…; also add 'npm run lint:license-files' so that lint fails if a new dep doesn't have a license or license file that will be needed for release
…I linting node versions to v16 for npm@8 to run 'npm run lint:license-files'
…lder versions of node and get a warning, not a hard failure (this is the same behaviour as our eslint linting)
@trentm
Copy link
Member Author

trentm commented Jun 14, 2022

@astorm CI passing again. I've added a npm run lint:license-files. This is ready for a second review.

@trentm trentm merged commit 844b2e4 into main Jun 16, 2022
@trentm trentm deleted the trentm/notice-gen branch June 16, 2022 20:34
APM-Agents (OLD) automation moved this from In Progress to Done Jun 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
agent-nodejs Make available for APM Agents project planning.
Projects
Development

Successfully merging this pull request may close these issues.

None yet

3 participants