chore: configure FOSSA

FOSSA was giving us a bunch of warnings about copyleft licenses, but these licenses are only present in our examples.  This configuration file will tell FOSSA to ignore that stuff.

FOSSA recognizes `examples/` as something it should skip, but not `sample-code`.  It's easier to rename the dir than it is to negotiate a PR with FOSSA.  Why they don't allow the config file to just ignore directories is beyond me...
This commit is contained in:
Christopher Hiller
2021-08-12 11:47:56 -07:00
parent 797a1990a6
commit 76d147aba1
6 changed files with 97 additions and 21 deletions

View File

@@ -1,6 +1,6 @@
coverage
node_modules
sample-code/javascript-wd
examples/javascript-wd
packages/*/build/**/*
**/*.min.js

64
.fossa.yml Executable file
View File

@@ -0,0 +1,64 @@
# Generated by FOSSA CLI (https://github.com/fossas/fossa-cli)
# Visit https://fossa.com to learn more
version: 2
cli:
server: https://app.fossa.com
fetcher: git
project: github.com/appium/appium
analyze:
modules:
- name: appium-monorepo
type: npm
target: .
path: .
options:
strategy: node_modules
- name: appium
type: npm
target: ./packages/appium
path: ./packages/appium
options:
strategy: node_modules
- name: '@appium/base-driver'
type: npm
target: ./packages/base-driver
path: ./packages/base-driver
options:
strategy: node_modules
- name: '@appium/doctor'
type: npm
target: ./packages/doctor
path: ./packages/doctor
options:
strategy: node_modules
- name: eslint-config-appium
type: npm
target: ./packages/eslint-config-appium
path: ./packages/eslint-config-appium
options:
strategy: node_modules
- name: '@appium/fake-driver'
type: npm
target: ./packages/fake-driver
path: ./packages/fake-driver
options:
strategy: node_modules
- name: '@appium/gulp-plugins'
type: npm
target: ./packages/gulp-plugins
path: ./packages/gulp-plugins
options:
strategy: node_modules
- name: '@appium/support'
type: npm
target: ./packages/support
path: ./packages/support
options:
strategy: node_modules
- name: '@appium/test-support'
type: npm
target: ./packages/test-support
path: ./packages/test-support
options:
strategy: node_modules

View File

@@ -28,6 +28,6 @@ If you are reporting a bug, _always_ include Appium logs!
Please remember that with sample code it's easier to reproduce the bug and it's much faster to fix it.
Please git clone https://github.com/appium/appium and from the `sample-code` directory, use one of your favourite languages and sample apps to reproduce the issue.
Please git clone https://github.com/appium/appium and from the `examples` directory, use one of your favourite languages and sample apps to reproduce the issue.
In case a similar scenario is missing in sample-code, please submit a PR with one of the sample apps provided.
In case a similar scenario is missing in examples, please submit a PR with one of the sample apps provided.

View File

@@ -24,6 +24,18 @@ jobs:
npm run install-fake-driver
npm run e2e-test
fossa-scan:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Analyze with FOSSA
- run: |
npm install
curl https://raw.githubusercontent.com/fossas/fossa-cli/master/install.sh | sudo bash
fossa analyze
env:
FOSSA_API_KEY: ${{secrets.FOSSA_API_KEY}}
generate_docs:
needs: [build]
runs-on: ubuntu-latest

28
.gitignore vendored
View File

@@ -8,10 +8,10 @@ xcuserdata
*.sublime-*
test/functional/_joined
*.iml
!sample-code/java/*.iml
!examples/java/*.iml
*.autosave
.idea/
!sample-code/java/.idea/
!examples/java/.idea/
*.log
*.t
artifacts
@@ -40,18 +40,18 @@ old
.tern-project
coverage
docs/mkdocs.yml
sample-code/javascript-wd/node_modules
sample-code/php/vendor
sample-code/php/composer.lock
sample-code/java/out/
sample-code/ruby/Gemfile.lock
sample-code/python/test/results/
sample-code/python/test/input
sample-code/python/.pytest_cache/
sample-code/csharp/test/bin
sample-code/csharp/test/obj
sample-code/csharp/test/bin
sample-code/csharp/packages
examples/javascript-wd/node_modules
examples/php/vendor
examples/php/composer.lock
examples/java/out/
examples/ruby/Gemfile.lock
examples/python/test/results/
examples/python/test/input
examples/python/.pytest_cache/
examples/csharp/test/bin
examples/csharp/test/obj
examples/csharp/test/bin
examples/csharp/packages
appium.zip
.vscode/settings.json
.nyc_output

View File

@@ -1,11 +1,11 @@
# Sample Code
# Examples
Sample Appium code written in multiple client languages
> Appium examples code written in multiple client languages!
## Running sample code
* Follow the [Appium setup guide](https://github.com/appium/appium/blob/master/docs/en/about-appium/getting-started.md) to install Appium locally.
* Choose the client library that you wish to run and then follow the guide in `sample-code/<client-language>/README.md` (e.g.: `sample-code/java/README.md`)
* Choose the client library that you wish to run and then follow the guide in `examples/<client-language>/README.md` (e.g.: `examples/java/README.md`)
## Environment variables
@@ -14,4 +14,4 @@ Sample Appium code written in multiple client languages
* `IOS_PLATFORM_VERSION`: Sets the `platformVersion` capability for iOS. Otherwise uses some default
* `ANDROID_DEVICE_NAME`: Sets the `deviceName` capability for Android. Otherwise uses some default
* `ANDROID_PLATFORM_VERSION`: Sets the `platformVersion` capability for Android. Otherwise uses some default
* `SAUCE_LABS`: If set to true, runs tests on Sauce Labs. Requires being setup on SauceLabs to run these tests.
* `SAUCE_LABS`: If set to true, runs tests on Sauce Labs. Requires being setup on SauceLabs to run these tests.