Skip to content
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
54 changes: 0 additions & 54 deletions .github/workflows/render-all.yml

This file was deleted.

83 changes: 83 additions & 0 deletions .github/workflows/render-site.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@

# It was adapted by Candace Savonen for the OTTR_template https://github.com/jhudsl/OTTR_Template.

# This code was adapted by Carrie Wright to enable automated rendering of the site associated with this repository

name: Render html

# Controls when the action will run. Triggers the workflow on push
# events only for the master branch
on:
workflow_dispatch:
push:
branches: [ main ]
paths:
- '**.Rmd'
- styles.css
- _site.yml
- resources/images/*.png
- resources/images/favicon.ico

jobs:
yaml-check:
name: Load user automation choices
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

# Use the yaml-env-action action.
- name: Load environment from YAML
uses: doughepi/yaml-env-action@v1.0.0
with:
files: config_automation.yml # Pass a space-separated list of configuration files. Rightmost files take precedence.

outputs:
rendering_docker_image: "${{ env.RENDERING_DOCKER_IMAGE }}"

# This workflow contains a single job called "build-all"
render-main:
Comment on lines +23 to +39

Check warning

Code scanning / CodeQL

Workflow does not contain permissions Medium

Actions job or workflow does not limit the permissions of the GITHUB_TOKEN. Consider setting an explicit permissions block, using the following as a minimal starting point: {contents: read}

Copilot Autofix

AI about 1 year ago

To fix the issue, we will add a permissions block to the workflow. This block will specify the minimal permissions required for the workflow to function correctly. Based on the workflow's actions, it needs contents: write to commit changes to the repository and possibly contents: read for other operations. We will add the permissions block at the root level of the workflow to apply to all jobs unless overridden.

Suggested changeset 1
.github/workflows/render-site.yml

Autofix patch

Autofix patch
Run the following command in your local git repository to apply this patch
cat << 'EOF' | git apply
diff --git a/.github/workflows/render-site.yml b/.github/workflows/render-site.yml
--- a/.github/workflows/render-site.yml
+++ b/.github/workflows/render-site.yml
@@ -6,2 +6,4 @@
 name: Render html
+permissions:
+  contents: write
 
EOF
@@ -6,2 +6,4 @@
name: Render html
permissions:
contents: write

Copilot is powered by AI and may make mistakes. Always verify output.
needs: yaml-check
runs-on: ubuntu-latest
container:
image: ${{needs.yaml-check.outputs.rendering_docker_image}}

steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- name: checkout
uses: actions/checkout@v4
with:
# get the full repo
fetch-depth: 0
# use github PAT
token: ${{ secrets.GH_PAT }}

# We want a fresh run of the renders each time - so first delete old html files
- name: Delete old *.html
run: Rscript -e "rmarkdown::clean_site(preview = FALSE)"

# Now we want to render all the html files from the Rmd files
- name: Run render html
id: site
run: Rscript -e "rmarkdown::render_site()"

# This checks on the steps before it and makes sure that they completed.
# If the renders didn't complete we don't want to commit the file changes
- name: Check on render steps
if: steps.site.outcome != 'success'
run: |
echo site status ${{steps.site.outcome}}
exit 1

# Commit the rendered site files - html files and site_libs files
# The git reset step will remove any other files created in this workflow, such as API keys
- name: Commit rendered site files
run: |
git config --global --add safe.directory $GITHUB_WORKSPACE
git config --global user.name 'github-actions[bot]'
git config --global user.email 'github-actions[bot]@users.noreply.github.com'
git add --force docs/*
git commit -m 'Render site' || echo "No changes to commit"
git reset --hard HEAD
git pull --rebase --allow-unrelated-histories --strategy-option=ours
git push origin main || echo "No changes to push"
Comment on lines +40 to +83

Check warning

Code scanning / CodeQL

Workflow does not contain permissions Medium

Actions job or workflow does not limit the permissions of the GITHUB_TOKEN. Consider setting an explicit permissions block, using the following as a minimal starting point: {contents: read}

Copilot Autofix

AI about 1 year ago

To fix the issue, we will add a permissions block to the workflow. This block will be added at the root level to apply to all jobs in the workflow. Based on the workflow's operations, the minimal required permissions are contents: read for reading repository content and contents: write for committing rendered site files. We will also ensure no unnecessary permissions are granted.


Suggested changeset 1
.github/workflows/render-site.yml

Autofix patch

Autofix patch
Run the following command in your local git repository to apply this patch
cat << 'EOF' | git apply
diff --git a/.github/workflows/render-site.yml b/.github/workflows/render-site.yml
--- a/.github/workflows/render-site.yml
+++ b/.github/workflows/render-site.yml
@@ -6,2 +6,4 @@
 name: Render html
+permissions:
+  contents: write
 
EOF
@@ -6,2 +6,4 @@
name: Render html
permissions:
contents: write

Copilot is powered by AI and may make mistakes. Always verify output.
Loading