Documenter.jl: Add code coverage from deployed docs?

[briochemc]

I use GitHub actions to deploy documentation (using Literate) separately from test/runtests.jl. The code bits are run and the output shows nicely in the docs and the notebooks, which is great (thanks Documenter × Literate!). But I would also like to get code coverage data from the code in the docs (using codecov). Is this possible? If yes, how?

I was assuming this required adding these last three lines (see below) to my docs.yml file (the top part comes from Documenter's GitHub-Actions docs):

name: Documentation

on:
  push:
    branches:
      - master
    tags: '*'
  pull_request:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: julia-actions/setup-julia@latest
        with:
          version: '1.4'
      - name: Install dependencies
        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
      - name: Build and deploy
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
        run: julia --project=docs/ docs/make.jl
      # I added these 3 lines below
      - uses: julia-actions/julia-uploadcodecov@latest
        env:
          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

but I don't think it works. Maybe there's something else to do? Or maybe something entirely different? Or maybe it can't be done at all? Any pointers appreciated!

[fredrikekre]

That should work. What you are missing is probably just to start Julia with --code-coverage=user, i.e.

run: julia --project=docs/ --code-coverage=user docs/make.jl

[briochemc]

Great! Thanks for your help @fredrikekre! I think this worked! @mortenpi do you think this should be added to Documenter's docs?

[mortenpi]

Yeah, I think it could be a useful thing to mention.