srcup-ci-action

Latest version: v0.0.1

This action wraps Dedaub's srcup tool as a github action so that it can be easily used in workflows

Usage

See action.yml

Inputs

The action expects a number of inputs:

• name: The name of the project. If one is not provided the name of the directory containing the project will be used
• comment: (optional) An optional short comment (commit message) describing the changes that the version of the uploaded project contains
• init: (optional) If is set to true then it is assumed that this is the first (initial) version of the project uploaded. Leave empty or undefined otherwise
• owner: (optional) If you are submitting for a project that is not owned by you, the username of the owner
• framework: (optional) The project's framework. See the documentation in srcup
• api-key: (optional) The key is optional if you configured the runner to use a configuration file. Otherwise needs to be provided
• cache: (optional) If cache should be used. See the documentation in srcup
• location: Location of the project's sources. Defaults to the current directory

Outputs

The action produces two outputs: project_id and version_id

Example

The following is an example of how the action can be used in a workflow (together with its sister action srcwarnings-ci-action

      - name: Run srcup
        id: srcup
        uses: dedaub/srcup-ci-action@v0.0.1
        with: 
          name: 'cool-project-name'
          api-key: ${{ secrets.WATCHDOG_SECRET }}
          framework: 'Hardhat'
          location: staking-v0.1
      - name: Get analysis summary
        id: get_project_report
        uses: dedaub/srcwarnings-ci-action@0.0.1
        with:
          project-id: ${{ steps.srcup.outputs.project_id }}
          version-id: ${{ steps.srcup.outputs.version_id }}
          api-key: ${{ secrets.WATCHDOG_SECRET }}
      - name: Print the info
        run: | 
          echo ${{ steps.get_project_report.outputs.project_report }}
          echo ${{ steps.get_project_report.outputs.project_report }} >> $GITHUB_STEP_SUMMARY
        shell: bash