diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index a9c0161..f5e3419 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,2 +1,2 @@ \ No newline at end of file +👉 https://opencollective.com/android-security-awesome/donate --> diff --git a/.github/workflows/lint-markdown.yaml b/.github/workflows/lint-markdown.yaml new file mode 100644 index 0000000..b2ef949 --- /dev/null +++ b/.github/workflows/lint-markdown.yaml @@ -0,0 +1,44 @@ +--- +# Run this locally with act - https://github.com/nektos/act +# act -j lintMarkdown +name: Lint Markdown + +on: # yamllint disable-line rule:truthy + push: + branches: [master, main] + paths: + - '**.md' + - '.github/workflows/lint-markdown.yaml' + pull_request: + branches: [master, main] + paths: + - '**.md' + - '.github/workflows/lint-markdown.yaml' + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + lintMarkdown: + runs-on: ubuntu-latest + timeout-minutes: 15 + + steps: + - name: Checkout code + uses: actions/checkout@v3 + + - name: Set up Ruby + # See https://github.com/ruby/setup-ruby#versioning + uses: ruby/setup-ruby@v1 + with: + ruby-version: 3.0 + + - name: Install dependencies + run: gem install mdl + + - name: Run tests + # Rule list: https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md + # Don't check for line length (MD013) + # Don't care about list ordering (MD029) + run: mdl --git-recurse --rules ~MD013,~MD029 . diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml deleted file mode 100644 index ee2be4c..0000000 --- a/.github/workflows/lint.yml +++ /dev/null @@ -1,36 +0,0 @@ -# This workflow uses actions that are not certified by GitHub. -# They are provided by a third-party and are governed by -# separate terms of service, privacy policy, and support -# documentation. -# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake -# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby - -name: Lint - -on: - push: - branches: [ master ] - pull_request: - branches: [ master ] - -jobs: - test: - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v2 - - name: Set up Ruby - # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby, - # change this to (see https://github.com/ruby/setup-ruby#versioning): - # uses: ruby/setup-ruby@v1 - uses: ruby/setup-ruby@v1 - with: - ruby-version: 2.6 - - name: Install dependencies - run: gem install mdl - - name: Run tests - run: | - # Lint - disable some rules - https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md - mdl -r ~MD013,~MD029,~MD033 README.md - diff --git a/README.md b/README.md index 6f7d7d0..20c102b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# android-security-awesome ![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg) [![Lint](https://github.com/ashishb/android-security-awesome/actions/workflows/lint.yml/badge.svg)](https://github.com/ashishb/android-security-awesome/actions/workflows/lint.yml) [![Test](https://github.com/ashishb/android-security-awesome/actions/workflows/test.yml/badge.svg)](https://github.com/ashishb/android-security-awesome/actions/workflows/test.yml) +# android-security-awesome ![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg) [![Lint Markdown](https://github.com/ashishb/android-security-awesome/actions/workflows/lint-markdown.yaml/badge.svg)](https://github.com/ashishb/android-security-awesome/actions/workflows/lint-markdown.yaml) [![Test](https://github.com/ashishb/android-security-awesome/actions/workflows/test.yml/badge.svg)](https://github.com/ashishb/android-security-awesome/actions/workflows/test.yml) A collection of android security related resources. @@ -6,7 +6,7 @@ A collection of android security related resources. 2. [Academic/Research/Publications/Books](#academic) 3. [Exploits/Vulnerabilities/Bugs](#exploits) -## Tools +## Tools ### Online Analyzers @@ -212,7 +212,7 @@ A collection of android security related resources. 6. [Insecureshop](https://github.com/optiv/insecureshop) 1. [Oversecured Vulnerable Android App (OVAA)](https://github.com/oversecured/ovaa) -## Academic/Research/Publications/Books +## Academic/Research/Publications/Books ### Research Papers @@ -233,7 +233,7 @@ A collection of android security related resources. 5. [Android Reverse Engineering 101 by Daniele Altomare (Web Archive link)](http://web.archive.org/web/20180721134044/http://www.fasteque.com:80/android-reverse-engineering-101-part-1/) 5. ~~[Mobile Security Reading Room](https://mobile-security.zeef.com) - A reading room which contains well categorised technical reading material about mobile penetration testing, mobile malware, mobile forensics and all kind of mobile security related topics~~ -## Exploits/Vulnerabilities/Bugs +## Exploits/Vulnerabilities/Bugs ### List