eric-haibin-lin closed pull request #10390: Initial PR for RAT License Check 
URL: https://github.com/apache/incubator-mxnet/pull/10390
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/tests/nightly/apache_rat_license_check/.rat-excludes b/tests/nightly/apache_rat_license_check/.rat-excludes
new file mode 100644
index 00000000000..b236ade7aee
--- /dev/null
+++ b/tests/nightly/apache_rat_license_check/.rat-excludes
@@ -0,0 +1,54 @@
+.*xml
+\..*
+.*css
+\\.*
+.*ipynb
+.*html
+.*json
+.*js
+.*txt
+.*md
+3rdparty/*
+R-package/*
+src/operator/mkl/*
+trunk/*
+docker/*
+docker_multiarch/*
+.*\\.m
+.*\\.mk
+.*\\.R
+contrib/*
+Dockerfile*
+.*svg
+.*cfg
+.*config
+docs/*
+__init__.py
+build/*
+.*\\.t
+perl-package/*
+.*csv
+.*names
+CODEOWNERS
+prepare_mkl.sh
+readthedocs.yml
+snap.python
+snapcraft.yaml
+image-classification-predict.cc
+bbox.pyx
+cpu_nms.pyx
+gpu_nms.pyx
+nms_kernel.cu
+_mask.pyx
+unicodemap_en_baidu.csv
+coco.py
+base.pyi
+special_functions-inl.h
+im2col.cuh
+im2col.h
+pool.h
+README.rst
+dataset.cPickle
+
+rcnn/*
+image-classification/*
\ No newline at end of file
diff --git a/tests/nightly/apache_rat_license_check/README.md b/tests/nightly/apache_rat_license_check/README.md
new file mode 100644
index 00000000000..b040882080d
--- /dev/null
+++ b/tests/nightly/apache_rat_license_check/README.md
@@ -0,0 +1,36 @@
+# Apache RAT License Check
+
+This is a nightly test that runs the Apache Tool RAT to check the License Headers on all source files
+ 
+### The .rat-excludes file
+This file lists all the files, directories and file formats that are excluded from license checks for various reasons.
+If you think something is wrong, feel free to change!
+
+### Nightly test script for license check
+Coming soon...
+
+### How to run the RAT check locally
+The following commands can be used to run a Apache RAT check locally - 
+
+```
+#install maven
+sudo apt-get install maven -y #>/dev/null
+
+#install svn
+sudo apt-get install subversion -y #>/dev/null
+
+#download RAT
+svn co http://svn.apache.org/repos/asf/creadur/rat/trunk/ #>/dev/null
+
+#cd into correct directory
+cd trunk
+
+#install step
+mvn install #>/dev/null
+
+#If build success:
+cd apache-rat/target
+
+#run Apache RAT check on the src
+java -jar apache-rat-0.13-SNAPSHOT.jar -E <path-to-.rat-excludes-file> -d <path-to-mxnet-source>
+```


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services