search

villano-lab / nrCascadeSim

calculating the NR spectrum resulting from neutron-capture cascades.
MIT License
0 stars 1 forks source link

Badges! More Badges. #37

Closed villaa closed 2 years ago

villaa commented 2 years ago

I think it might be useful to have the badges similar to emcee. Specifically the license, arxiv, and coverage badge might be useful.

villaa commented 2 years ago

The code-coverage badge can be seen in the obscura code.

It is installed under a github workflow .github/workflows/main.yml in obscura. The installation and execution look like:

    # CODECOV
    - name: Install codecov
      shell: bash
      run: sudo pip install codecov

    # CODE COVERAGE
    - name: Code coverage - Capture coverage info
      working-directory: ${{runner.workspace}}
      run: lcov --directory . --capture --output-file coverage.info
    - name: Code coverage - Filter out system, external, and unit test source files
      working-directory: ${{runner.workspace}}
      run: lcov --remove coverage.info '/Library/*' '/usr/*' "${HOME}"'/.cache/*' '*/tests/*' '*/external/*' --output-file coverage.info
    - name: Code coverage - Output coverage data for debugging
      working-directory: ${{runner.workspace}}
      run: lcov --list coverage.info
    - name: Code coverage - Upload to CodeCov
      working-directory: ${{runner.workspace}}
      run:  bash <(curl -s https://codecov.io/bash) -f coverage.info || echo "Codecov did not collect coverage reports"