Code Monkey home page Code Monkey logo

oversecured-github's Introduction

Oversecured Action for GitHub

This GitHub Action enables you to automatically upload your app versions to Oversecured for security scanning. An action user must have an active Integration.

Inputs

  • access_token: Required. Your Oversecured API key
  • integration_id: Required. The integration ID from Oversecured
  • branch_name: Optional. The branch name, main is default
  • app_path: Required. The path to the app file you wish to upload

Usage

  1. Store your Oversecured API key as a secret in your GitHub repository. Navigate to your GitHub repository, go to the Settings tab, select Secrets from the left sidebar, and click the New repository secret button. Name the secret OVERSECURED_API_KEY and paste your key.
  2. Add the Oversecured job to your GitHub Actions workflow.

Android example:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Change wrapper permissions
        run: chmod +x ./gradlew

      - name: Build gradle project
        run: ./gradlew build

      - name: Build debug apk
        run: ./gradlew assembleDebug

      - name: Oversecured Scanner
        uses: oversecured/oversecured-github@v1
        with:
          access_token: ${{ secrets.OVERSECURED_API_KEY }}
          integration_id: ${{ vars.OVERSECURED_INTEGRATION_ID }}
          branch_name: ${{ vars.OVERSECURED_BRANCH_NAME }}
          app_path: ./app/build/outputs/apk/debug/app-debug.apk

iOS example:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Pods Install
        run: |
          pod install

      - name: Zip Sources
        run: |
          zip -q -r OversecuredZipped.zip .

      - name: Oversecured Scanner
        uses: oversecured/oversecured-github@v1
        with:
          access_token: ${{ secrets.OVERSECURED_API_KEY }}
          integration_id: ${{ vars.OVERSECURED_INTEGRATION_ID }}
          branch_name: ${{ vars.OVERSECURED_BRANCH_NAME }}
          app_path: OversecuredZipped.zip

Have Question or Feedback?

Submit a request using the contact form.

License

The scripts and documentation in this project are released under the MIT License.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.