Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

[WIP] [v1.x] Create tool for building source archives #19972

Merged
merged 10 commits into from
Mar 5, 2021

Conversation

josephevans
Copy link
Contributor

Description

This PR introduces a script that automates creating a release source archive and handles some licensing issues by removing some files that were identified to be non-compliant, and introducing a Apache RAT license check in the source generation process to ensure all Apache MXNet code is compliant.

@josephevans josephevans requested a review from szha as a code owner March 2, 2021 23:33
@mxnet-bot
Copy link

Hey @josephevans , Thanks for submitting the PR
All tests are already queued to run once. If tests fail, you can trigger one or more tests again with the following commands:

  • To trigger all jobs: @mxnet-bot run ci [all]
  • To trigger specific jobs: @mxnet-bot run ci [job1, job2]

CI supported jobs: [centos-gpu, unix-gpu, edge, clang, windows-cpu, unix-cpu, centos-cpu, miscellaneous, windows-gpu, website, sanity]


Note:
Only following 3 categories can trigger CI :PR Author, MXNet Committer, Jenkins Admin.
All CI tests must pass before the PR can be merged.

@lanking520 lanking520 added the pr-work-in-progress PR is still work in progress label Mar 2, 2021
@Zha0q1
Copy link
Contributor

Zha0q1 commented Mar 3, 2021

@josephevans Does this same tool also work for master?

@josephevans
Copy link
Contributor Author

@josephevans Does this same tool also work for master?

There will be some slight modifications for master (there's no R-package in master, which we remove in v1.x.)

…ill not be distributing these in the source archive.
…nce we will not be distributing these in the source archive."

This reverts commit 123cb72.
@josephevans
Copy link
Contributor Author

I was going to remove mx-theme references in the LICENSE file, but it looks like @szha already has them removed in #19873. Should we also remove references to mathjax (from mkldnn docs) in LICENSE since we will no longer be shipping it out in the source archive? @leezu

@leezu
Copy link
Contributor

leezu commented Mar 3, 2021

Should we also remove references to mathjax (from mkldnn docs) in LICENSE since we will no longer be shipping it out in the source archive?

One idea is to automatically remove lines fro LICENSE that match a line in tools/source-exclude-artifacts.txt?

@szha
Copy link
Member

szha commented Mar 3, 2021

It would be great to add a check for all files listed in license and warn if any doesn't exist

@josephevans
Copy link
Contributor Author

josephevans commented Mar 3, 2021

It would be great to add a check for all files listed in license and warn if any doesn't exist

Added this to the script. Found 2 items in the LICENSE file that are no longer in the source tree and removed them.

Perhaps this should be part of the normal sanity rat check CI pipeline so we catch the issues earlier instead of at release time. WDYT? But that will have to be part of a different PR.

@josephevans
Copy link
Contributor Author

Should we also remove references to mathjax (from mkldnn docs) in LICENSE since we will no longer be shipping it out in the source archive?

One idea is to automatically remove lines fro LICENSE that match a line in tools/source-exclude-artifacts.txt?

OK, I updated to remove lines in LICENSE for stuff we remove the source archive.

@szha szha merged commit 098af4f into apache:v1.x Mar 5, 2021
josephevans added a commit to josephevans/mxnet that referenced this pull request Mar 5, 2021
Zha0q1 pushed a commit that referenced this pull request Mar 9, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
pr-work-in-progress PR is still work in progress
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants