Update the docs #4
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
| # Copyright (C) 2024 Roberto Rossini <[email protected]> | |
| # SPDX-License-Identifier: MIT | |
| name: Lint CITATION.cff | |
| on: | |
| push: | |
| branches: [main] | |
| paths: | |
| - ".github/workflows/lint-cff.yml" | |
| - "CITATION.cff" | |
| pull_request: | |
| paths: | |
| - ".github/workflows/lint-cff.yml" | |
| - "CITATION.cff" | |
| # https://stackoverflow.com/a/72408109 | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| defaults: | |
| run: | |
| shell: bash | |
| jobs: | |
| lint-cff: | |
| runs-on: ubuntu-latest | |
| name: Lint CITATION.cff | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| sparse-checkout: CITATION.cff | |
| sparse-checkout-cone-mode: false | |
| - name: Generate DESCRIPTION file | |
| run: | | |
| cat << EOF > DESCRIPTION | |
| Package: hictkpy | |
| Title: What the Package Does (One Line, Title Case) | |
| Version: 0.0.0.9000 | |
| Authors@R: | |
| person("First", "Last", , "[email protected]", role = c("aut", "cre")) | |
| Description: What the package does (one paragraph). | |
| License: MIT | |
| Encoding: UTF-8 | |
| Roxygen: list(markdown = TRUE) | |
| RoxygenNote: 7.3.2 | |
| Imports: | |
| cffr | |
| EOF | |
| - name: Setup R | |
| uses: r-lib/actions/setup-r@v2 | |
| - name: Add requirements | |
| uses: r-lib/actions/setup-r-dependencies@v2 | |
| - name: Lint CITATION.cff | |
| run: Rscript -e 'cffr::cff_validate("CITATION.cff")' |