Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move pages to github actions #1423

Merged
merged 5 commits into from
Jun 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
name: Deploy gh-pages

on:
push:
branches: ["master"]

workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup build
working-directory: r-package/grf
run: |
# Install pandoc
sudo apt-get install -qq pandoc

# Install R
curl -OLs https://eddelbuettel.github.io/r-ci/run.sh && chmod 0755 run.sh
./run.sh bootstrap
./run.sh install_all

# Install grf
R CMD INSTALL .
- name: Setup docs
working-directory: r-package/grf
run: |
# Install pkgdown v1.5
sudo Rscript -e "install.packages(c('fs', 'highlight', 'httr', 'memoise', 'openssl', 'purrr', 'rmarkdown', 'rstudioapi', 'whisker', 'xml2', 'yaml'))"
sudo Rscript -e "install.packages('https://cran.r-project.org/src/contrib/Archive/pkgdown/pkgdown_1.5.1.tar.gz', repos = NULL, type = 'source')"

# Install packages used in vignettes
sudo Rscript -e "install.packages(c('ggplot2', 'glmnet', 'maq', 'policytree'))"
- name: Build docs
working-directory: r-package/grf
run: |
# Build site
cp ../../README.md .
cp ../../REFERENCE.md .
cp ../../DEVELOPING.md .
cp ../../releases/CHANGELOG.md .
Rscript -e "pkgdown::build_site()"
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: 'r-package/grf/docs'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
34 changes: 0 additions & 34 deletions azure-pipelines.yml
Original file line number Diff line number Diff line change
Expand Up @@ -106,37 +106,3 @@ jobs:
workingDirectory: r-package/grf
displayName: Valgrind check
condition: eq(variables['Agent.OS'], 'Linux')
# Final deploy step:
# Build the online docs and deploy to gh-pages - only done on master branch with Linux image.
# `GITHUB_PAT` is a GitHub access token stored on Azure Pipelines.
- script: |
set -e
sudo apt-get install -qq pandoc
# Lock in a previous version of `pkgdown` and its dependencies.
sudo Rscript -e "install.packages(c('fs', 'highlight', 'httr', 'memoise', 'openssl', 'purrr', 'rmarkdown', 'rstudioapi', 'whisker', 'xml2', 'yaml'))"
sudo Rscript -e "install.packages('https://cran.r-project.org/src/contrib/Archive/pkgdown/pkgdown_1.5.1.tar.gz', repos = NULL, type = 'source')"
# Install dependencies needed for vignettes.
sudo Rscript -e "install.packages(c('DiagrammeR', 'ggplot2', 'glmnet', 'maq', 'policytree', 'rdd'))"
cp ../../README.md .
cp ../../REFERENCE.md .
cp ../../DEVELOPING.md .
cp ../../releases/CHANGELOG.md .
# Build and deploy page. This requires that the branch `gh-pages` exists.
# git worktree is used to only commit the doc folder (docs/) as the root.
# update-ref is used to not keep a commit history of the generated docs.
git config --local user.email "[email protected]"
git config --local user.name "Azure Pipelines"
git worktree add -B gh-pages docs/ origin/gh-pages
rm -rf docs/*
Rscript -e "pkgdown::build_site()"
cd docs
git add --all
git update-ref -d refs/heads/gh-pages
git commit --allow-empty -m "Update gh-pages ***NO_CI***"
git push --force https://$(GITHUB_PAT)@github.com/grf-labs/grf.git HEAD:gh-pages
workingDirectory: r-package/grf
displayName: 'Publish GitHub Pages'
condition: |
and(eq(variables['Agent.OS'], 'Linux'),
and(not(eq(variables['Build.Reason'], 'PullRequest')),
eq(variables['Build.SourceBranch'], 'refs/heads/master')))