NLeSC / python-template

Netherlands eScience Center Python Template
https://research-software-directory.org/software/nlesc-python-template
Apache License 2.0
196 stars 77 forks source link

Sonar token missing warning when not setup #220

Open sverhoeven opened 3 years ago

sverhoeven commented 3 years ago

Pushing a generated project to GitHub will trigger the .github/workflows/sonarcloud.yml workflow to be run. However Sonar token has not been setup yet then the workflow will fail with a unpleasant error. It would be nice if we could give a gentler warning pointing to the setup docs.

sverhoeven commented 3 years ago

Could be solved following instructions in Next step: Sonarcloud integration issue. Lets link to that issue in our custom warning message.

sverhoeven commented 3 years ago

The built-in error looks like this

Run SonarSource/sonarcloud-github-action@master
  with:
    projectBaseDir: .
  env:
    pythonLocation: /opt/hostedtoolcache/Python/3.9.4/x64
    LD_LIBRARY_PATH: /opt/hostedtoolcache/Python/3.9.4/x64/lib
    GITHUB_TOKEN: ***
    SONAR_TOKEN: 
/usr/bin/docker run --name a33c1dcd4548f200c468788768eac4a8105e4_c64152 --label 8a33c1 --workdir /github/workspace --rm -e pythonLocation -e LD_LIBRARY_PATH -e GITHUB_TOKEN -e SONAR_TOKEN -e INPUT_ARGS -e INPUT_PROJECTBASEDIR -e HOME -e GITHUB_JOB -e GITHUB_REF -e GITHUB_SHA -e GITHUB_REPOSITORY -e GITHUB_REPOSITORY_OWNER -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_RETENTION_DAYS -e GITHUB_ACTOR -e GITHUB_WORKFLOW -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GITHUB_EVENT_NAME -e GITHUB_SERVER_URL -e GITHUB_API_URL -e GITHUB_GRAPHQL_URL -e GITHUB_WORKSPACE -e GITHUB_ACTION -e GITHUB_EVENT_PATH -e GITHUB_ACTION_REPOSITORY -e GITHUB_ACTION_REF -e GITHUB_PATH -e GITHUB_ENV -e RUNNER_OS -e RUNNER_TOOL_CACHE -e RUNNER_TEMP -e RUNNER_WORKSPACE -e ACTIONS_RUNTIME_URL -e ACTIONS_RUNTIME_TOKEN -e ACTIONS_CACHE_URL -e GITHUB_ACTIONS=true -e CI=true -v "/var/run/docker.sock":"/var/run/docker.sock" -v "/home/runner/work/_temp/_github_home":"/github/home" -v "/home/runner/work/_temp/_github_workflow":"/github/workflow" -v "/home/runner/work/_temp/_runner_file_commands":"/github/file_commands" -v "/home/runner/work/justatest/justatest":"/github/workspace" 8a33c1:dcd4548f200c468788768eac4a8105e4
Set the SONAR_TOKEN env variable.