From f4610dd111cbd62156ca109ba5d64eb6a68b6988 Mon Sep 17 00:00:00 2001 From: Chun-Hui Gao Date: Tue, 19 Dec 2023 09:52:14 +0800 Subject: [PATCH] update GitHub action --- .Rbuildignore | 1 + .github/workflows/pkgdown.yaml | 70 ++++++++++++--------------- DESCRIPTION | 2 +- _pkgdown.yml | 86 +++++++++++++++++----------------- 4 files changed, 73 insertions(+), 86 deletions(-) diff --git a/.Rbuildignore b/.Rbuildignore index 1e9bf94..c11f55c 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -25,3 +25,4 @@ ^less-dependency.Rmd$ ^docs$ ^roadmap\.md$ +^pkgdown$ diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml index 58b43b2..ed7650c 100644 --- a/.github/workflows/pkgdown.yaml +++ b/.github/workflows/pkgdown.yaml @@ -1,60 +1,48 @@ +# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples +# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help on: push: - branches: - - main - - master + branches: [main, master] + pull_request: + branches: [main, master] + release: + types: [published] + workflow_dispatch: name: pkgdown jobs: pkgdown: runs-on: ubuntu-latest + # Only restrict concurrency for non-PR jobs + concurrency: + group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }} env: GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + permissions: + contents: write steps: - - uses: actions/checkout@v2 - - - uses: r-lib/actions/setup-r@v2 + - uses: actions/checkout@v3 - uses: r-lib/actions/setup-pandoc@v2 - - name: Query dependencies - run: | - install.packages('remotes') - saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2) - writeLines(sprintf("R-%i.%i", getRversion()$major, getRversion()$minor), ".github/R-version") - shell: Rscript {0} - - - name: Restore R package cache - uses: actions/cache@v2 + - uses: r-lib/actions/setup-r@v2 with: - path: ${{ env.R_LIBS_USER }} - key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }} - restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1- + use-public-rspm: true - - name: Install package dependencies - run: sudo apt-get install libcurl4-openssl-dev libudunits2-dev libgdal-dev libharfbuzz-dev libfribidi-dev - - - name: Install dependencies - run: | - remotes::install_deps(dependencies = TRUE) - install.packages("badger") - install.packages('plyr') - install.packages("pkgdown") - shell: Rscript {0} - - - name: Install package - run: R CMD INSTALL . + - uses: r-lib/actions/setup-r-dependencies@v2 + with: + extra-packages: any::pkgdown, local::. + needs: website - - name: Codecov analysis - run: | - install.packages("covr") - library("covr") - codecov() + - name: Build site + run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE) shell: Rscript {0} - - name: Deploy package - run: | - git config --local user.email "actions@github.com" - git config --local user.name "GitHub Actions" - Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE)' + - name: Deploy to GitHub pages 🚀 + if: github.event_name != 'pull_request' + uses: JamesIves/github-pages-deploy-action@v4.4.1 + with: + clean: false + branch: gh-pages + folder: docs diff --git a/DESCRIPTION b/DESCRIPTION index a2817ad..30309ce 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -28,7 +28,7 @@ Imports: aplot, forcats, tidyr -URL: https://github.com/gaospecial/ggVennDiagram +URL: https://github.com/gaospecial/ggVennDiagram, https://gaospecial.github.io/ggVennDiagram/ License: GPL-3 Encoding: UTF-8 RoxygenNote: 7.2.3 diff --git a/_pkgdown.yml b/_pkgdown.yml index a72e2c0..36ff733 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -1,47 +1,45 @@ +url: https://gaospecial.github.io/ggVennDiagram/ home: - strip_header: true - + strip_header: yes reference: - - title: Main wrapers - desc: Main functions of 'ggVennDiagram' - contents: - - ggVennDiagram - - plot_venn - - upset_plot - - - title: Shape viewer - desc: methods used to get and view shape data - contents: - - plot_shapes - - plot_shape_edge - - get_shapes - - get_shape_data - - get_shape_by_id - - - title: VennPlotData object and methods - desc: a S3 class to store Venn sets and shape data - - process_data - - plotData_add_venn - - VennPlotData - - venn_plot_data - - print - - - title: Venn object and methods - desc: a S4 class to store Venn sets and calculate subsets - contents: - - 'Venn-class' - - venn_region - - venn_regionedge - - venn_regionlabel - - venn_set - - venn_setedge - - venn_setlabel +- title: Main wrapers + desc: Main functions of 'ggVennDiagram' + contents: + - ggVennDiagram + - plot_venn + - upset_plot +- title: Shape viewer + desc: methods used to get and view shape data + contents: + - plot_shapes + - plot_shape_edge + - get_shapes + - get_shape_data + - get_shape_by_id +- title: VennPlotData object and methods + desc: a S3 class to store Venn sets and shape data + contents: + - process_data + - plotData_add_venn + - VennPlotData + - venn_plot_data + - print +- title: Venn object and methods + desc: a S4 class to store Venn sets and calculate subsets + contents: + - Venn-class + - venn_region + - venn_regionedge + - venn_regionlabel + - venn_set + - venn_setedge + - venn_setlabel +- title: subset processing + desc: helper functions to calculate subset members + contents: + - combinations + - all_identical + - discern_overlap + - overlap + - unite - - title: subset processing - desc: helper functions to calculate subset members - contents: - - combinations - - all_identical - - discern_overlap - - overlap - - unite