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

Generate NOTICE file for packages #3143

Closed
wants to merge 12 commits into from
Closed

Conversation

JillieBeanSim
Copy link
Contributor

@JillieBeanSim JillieBeanSim commented Sep 23, 2024

Proposed changes

Generate NOTICE file for packages, with NOTICE file header used from ZOWE CLI package from zowe.org/downloads distribution

can install new dependency into a package and run pnpm run update-notices to see the new package picked up and added to NOTICE file for the ZE package updated. This command will be added to the release preparation and ran when new dependencies introduced into the packages having file changes verified then pushed into release PR along with lerna updates.

I do notice it doesn't add ZE API or our eslint-plugin with the SNAPSHOT in version, we will have to update that manually when command run for publishing.

adding Zowe package values manually where appropriate when missing after looking through files, all zowe packages will be updated for GA instances in release PR

Release Notes

Milestone: v3 GA

Changelog: Generate NOTICE file for package.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • Enhancement (non-breaking change which adds or improves functionality)
  • Breaking change (a change that would cause existing functionality to not work as expected)
  • Documentation (Markdown, README updates)
  • Other (please specify above in "Proposed changes" section)

Checklist

General

  • I have read the CONTRIBUTOR GUIDANCE wiki
  • All PR dependencies have been merged and published (if applicable)
  • A GIF or screenshot is included in the PR for visual changes
  • The pre-publish command has been executed:
    • v2 and below: yarn workspace vscode-extension-for-zowe vscode:prepublish
    • v3: pnpm --filter vscode-extension-for-zowe vscode:prepublish

Code coverage

  • There is coverage for the code that I have added
  • I have added new test cases and they are passing
  • I have manually tested the changes

Deployment

  • I have added developer documentation (if applicable)
  • Documentation should be added to Zowe Docs
    • If you're an outside contributor, please post in the #zowe-doc Slack channel to coordinate documentation.
    • Otherwise, please check with the rest of the squad about any needed documentation before merging.
  • These changes may need ported to the appropriate branches (list here):

Further comments

@JillieBeanSim JillieBeanSim self-assigned this Sep 23, 2024
Copy link

codecov bot commented Sep 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.80%. Comparing base (06c3caa) to head (1faa659).
Report is 45 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3143   +/-   ##
=======================================
  Coverage   92.80%   92.80%           
=======================================
  Files         113      113           
  Lines       11669    11669           
  Branches     2498     2494    -4     
=======================================
  Hits        10829    10829           
  Misses        838      838           
  Partials        2        2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@JillieBeanSim JillieBeanSim added this to the v3.0.0 GA milestone Sep 23, 2024
@JillieBeanSim JillieBeanSim marked this pull request as ready for review September 24, 2024 00:39
Copy link

📅 Suggested merge-by date: 10/8/2024

traeok
traeok previously approved these changes Sep 25, 2024
Copy link
Member

@traeok traeok left a comment

Choose a reason for hiding this comment

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

Thanks for generating these Billie - I noticed there are some merge conflicts but everything LGTM!

Copy link

Copy link
Member

@t1m0thyj t1m0thyj left a comment

Choose a reason for hiding this comment

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

Thanks @JillieBeanSim for setting up the script to generate NOTICE files.

We discussed on standup yesterday about the possibility of using a common Zowe pipeline to generate the notices. Worked with @MarkAckert to enhance the same dependency scanner workflow that is used for CLI and we've added a new licenses artifact for VSCode. Would this work for attribution purposes?

@JillieBeanSim
Copy link
Contributor Author

JillieBeanSim commented Sep 30, 2024

once we have our files zowe_licenses_vscode.zip included in the artifactory we can close this PR

PR to watch zowe/zowe-dependency-scan-pipeline#149

@zFernand0
Copy link
Member

Now that zowe/zowe-dependency-scan-pipeline#149 was merged, are we good to close this PR? 🙏

@JillieBeanSim
Copy link
Contributor Author

verified that our zip file is included in the 3.0.0 of artifactory

@JillieBeanSim JillieBeanSim deleted the chore/generate-notices branch October 1, 2024 12:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Closed
Development

Successfully merging this pull request may close these issues.

4 participants