More descriptive README.md #718
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Documentation | |
| on: | |
| push: | |
| branches: | |
| - main | |
| tags: '*' | |
| pull_request: | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Cancel Previous Runs | |
| uses: styfle/[email protected] | |
| with: | |
| access_token: ${{ github.token }} | |
| - uses: actions/checkout@v4 | |
| - uses: julia-actions/setup-julia@latest | |
| with: | |
| version: '1.10' | |
| show-versioninfo: true | |
| - name: Install dependencies | |
| run: | | |
| julia --color=yes --project -e 'using Pkg; Pkg.instantiate()' | |
| julia --color=yes --project -e 'using Pkg; Pkg.precompile()' | |
| julia --color=yes --project=docs/ -e 'using Pkg; Pkg.instantiate()' | |
| julia --color=yes --project=docs/ -e 'using Pkg; Pkg.precompile()' | |
| - 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 | |
| JULIA_DEBUG: Documenter | |
| ECCO_USERNAME: ${{ secrets.ECCO_USERNAME }} # To download ECCO data from the podaac website | |
| ECCO_PASSWORD: ${{ secrets.ECCO_PASSWORD }} # To download ECCO data from the podaac website | |
| run: julia --color=yes --project=docs/ docs/make_without_examples.jl |