Merge pull request #34 from fosslight/develop

Move user-guide link to FOSSLight guide & Add test workflow for windows and MacOS environment

Author: dd-jy

.github/workflows/pull-request.yml

@@ -7,7 +7,7 @@ on:
     branches: [ main ]
 
 jobs:
-  build:
+  build_ubuntu:
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -27,6 +27,54 @@ jobs:
     - name: Run Tox
       run: |
         tox -e run_ubuntu
+  build_windows:
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        python-version: [3.6]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox
+        pip install tox-wheel
+    - name: Run Tox
+      run: |
+        tox -e run_windows
+  build_macos:
+    runs-on: macos-latest
+    strategy:
+      matrix:
+        python-version: [3.6]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies 
+      run: |
+        python -m pip install --upgrade pip
+        pip install fosslight_dependency 
+        sudo npm install -g license-checker      
+    - name: Install Pod
+      working-directory: ./tests/test_cocoapods/cocoapods-tips/JWSCocoapodsTips
+      run: pod install --clean-install
+    - name: Run Test
+      run: |
+        fosslight_dependency -p tests/test_pypi -o tests/result/pypi
+        fosslight_dependency -p tests/test_npm1 -o tests/result/npm1
+        fosslight_dependency -p tests/test_npm2 -o tests/result/npm2 -m npm
+        fosslight_dependency -p tests/test_maven1/lombok.maven -o tests/result/maven1
+        fosslight_dependency -p tests/test_maven2 -o tests/result/maven2
+        fosslight_dependency -p tests/test_gradle/jib -o tests/result/gradle
+        fosslight_dependency -p tests/test_pub -o tests/result/pub
+        fosslight_dependency -p tests/test_cocoapods/cocoapods-tips/JWSCocoapodsTips -o tests/result/Cocoapods
   reuse:
     runs-on: ubuntu-latest
     steps: 

.reuse/dep5

@@ -61,3 +61,7 @@ License: Apache-2.0
 Files: tests/test_pypi/*
 Copyright: 2021 LG Electronics
 License: Apache-2.0
+
+Files: tests/test_cocoapods/cocoapods-tips*
+Copyright: 2017 ClintJang 
+License: MIT

README.md

@@ -20,9 +20,24 @@ Currently, it supports the following package managers.
 - [Pub](https://pub.dev/) (Dart with flutter)
 - [Cocoapods](https://cocoapods.org/) (Swift/Obj-C)
 
+## 🧐 How to analyze the dependencies
+
+FOSSLight Dependency Scanner utilizes the open source software for analyzing each package manager dependencies. We choose the open source software for each package manager that shows not only the direct dependencies but also the transitive dependencies including the information of dependencies such as oss name, oss version and license name.
+
+Each package manager uses the results of the following software:
+
+- NPM : [NPM License Checker](https://github.com/davglass/license-checker)
+- Pypi : [pip-licenses](https://github.com/raimon49/pip-licenses)
+- Gradle : [License Gradle Plugin](https://github.com/hierynomus/license-gradle-plugin)
+- Maven : [license-maven-plugin](https://github.com/mojohaus/license-maven-plugin)
+- Pub : [flutter_oss_licenses](https://github.com/espresso3389/flutter_oss_licenses)
+
+Because we utilizes the different open source software to analyze the dependencies of each package manager, you need to set up the **Prerequisite** steps in [User guide](https://fosslight.org/fosslight-guide-en/scanner/2_dependency.html) according to package manager to analyze.
+
 ## 📖 User Guide
 
-Please see the [**User Guide**](https://github.com/fosslight/fosslight_dependency_scanner/blob/main/docs/user-guide.md) for more information on how to install and run it.
+We describe the user guide in the FOSSLight guide page.
+Please see the [**User Guide**](https://fosslight.org/fosslight-guide-en/scanner/2_dependency.html) for more information on how to install and run it.
 
 ## 👏 Contributing Guide