Merge ebc8706 into 4f579c1

.github/ISSUE_TEMPLATE/course-content-add.md

@@ -3,15 +3,15 @@ name: New content idea
 about: Suggest an idea for the course
 title: ''
 labels: ''
-assignees: cansavvy
+assignees:
 
 ---
 
-**Describe the your scope of your content idea**
-What will this cover and how does it relate to the current course material?
+## Describe the your scope of your content idea
+<!-- What will this cover and how does it relate to the current course material? -->
 
-**Describe the learning objectives for your content idea**
-What will users learn from this new content? 
+## Describe the learning objectives for your content idea
+<!-- What will users learn from this new content? -->
 
-**Additional context or resources**
-Add any other context or related resources we should know about? 
+## Additional context or resources
+<!-- Add any other context or related resources we should know about? -->

.github/ISSUE_TEMPLATE/course-problem-report.md

@@ -1,27 +1,28 @@
 ---
 name: Course Problem Report
 about: Create a report to help improve the course
-title: problem
+title: [Problem]
 labels: bug
-assignees: cansavvy
+assignees:
 
 ---
 
-**Describe what is not working with the course**
-A clear and concise description of what the bug is.
+## Describe what is not working with the course
+<!-- A clear and concise description of what the bug is. -->
 
-**To Reproduce**
-Steps to reproduce the behavior:
+## Steps to Reproduce
+<!-- Steps to reproduce the behavior:
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
+-->
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+## Expected behavior
+<!-- A clear and concise description of what you expected to happen. -->
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+## Screenshots
+<!-- If applicable, add screenshots to help explain your problem. -->
 
-**Additional context**
-Add any other context about the problem here.
+## Additional context
+<!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/url-error.md

@@ -0,0 +1,8 @@
+---
+title: Broken URLs found in the course!
+labels: url-error
+---
+URL's in this course were just checked and some broken URLs were found.
+
+**Number of errors:** {{ env.ERROR_NUM }} 
+**File where errors are:** [url checks file here]({{ env.FILE_URL }})

.github/workflows/check-url.yml

@@ -0,0 +1,107 @@
+name: Periodic URL Check
+
+on:
+ workflow_dispatch:
+ schedule:
+ - cron: '0 0 1 * *'
+
+jobs:
+ set-up:
+ name: Load user automation choices
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v3
+ with:
+ fetch-depth: 0
+
+ # 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:
+ toggle_url_check_periodically: "${{ env.URL_CHECK_PERIODICALLY }}"
+
+ url-check:
+ name: Check URLs
+ needs: set-up
+ if: ${{needs.set-up.outputs.toggle_url_check_periodically == 'yes'}}
+ runs-on: ubuntu-latest
+ container:
+ image: jhudsl/base_ottr:main
+
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v3
+ with:
+ fetch-depth: 0
+
+ # Delete the branch if this has been run before
+ - name: Delete branch locally and remotely
+ run: git push origin --delete preview-spell-error || echo "No branch to delete"
+
+ # Make the branch fresh
+ - name: Make the branch fresh
+ 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'
+
+ echo branch doesnt exist
+ git checkout -b preview-spell-error || echo branch exists
+ git push --set-upstream origin preview-spell-error || echo echo branch exists remotely
+ shell: bash
+
+ - name: Run the check
+ uses: jhudsl/ottr-reports@main
+ id: check_results
+ continue-on-error: true
+ with:
+ check_type: urls
+ error_min: 1
+
+ - name: Declare file path and time
+ id: check-report
+ run: |
+ error_num=$(cat check_reports/url_checks.tsv | wc -l)
+ error_num="$((error_num-1))"
+ echo "error_num=$error_num" >> $GITHUB_OUTPUT
+ echo "error_url=https://github.com/${GITHUB_REPOSITORY}/blob/preview-spell-error/check_reports/url_checks.tsv" >> $GITHUB_OUTPUT
+ shell: bash
+
+ - name: Stop if failure
+ if: steps.check_results.outcome == 'failure'
+ run: exit 1
+
+ - name: Print out error variables
+ run: |
+ echo ${{ steps.check-report.outputs.error_url }}
+ echo ${{ steps.check-report.outputs.error_num }}
+
+ - name: Find issues
+ id: find-issue
+ env:
+ GH_PAT: ${{ secrets.GH_PAT }}
+ run: |
+ echo "$GITHUB_REPOSITORY"
+ curl -o find_issue.R https://raw.githubusercontent.com/jhudsl/ottr-reports/main/scripts/find_issue.R
+ issue_exists=$(Rscript --vanilla find_issue.R --repo $GITHUB_REPOSITORY --git_pat $GH_PAT)
+ echo URL issue exists: $issue_exists
+ echo "issue_existence=$issue_exists" >> $GITHUB_OUTPUT
+
+ - name: If too many URL errors, then make an issue
+ if: ${{ steps.check-report.outputs.error_num >= 1 && steps.find-issue.outputs.issue_existence == 0}}
+ uses: JasonEtco/create-an-issue@v2
+ with:
+ filename: .github/ISSUE_TEMPLATE/url-error.md
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ FILE_URL: ${{ steps.check-report.outputs.error_url }}
+ ERROR_NUM: ${{ steps.check-report.outputs.error_num }}
+
+ - name: If no URL errors than delete the branch we made
+ if: ${{ steps.check-report.outputs.error_num < 1 }}
+ run: |
+ git config --system --add safe.directory "$GITHUB_WORKSPACE"
+ git push origin --delete preview-spell-error || echo "No branch to delete"

.github/workflows/delete-preview.yml

@@ -7,17 +7,21 @@ on:
  types: [closed]
 
 jobs:
- build-all:
+ delete-preview:
  runs-on: ubuntu-latest
  steps:
+
  # This is because if a PR is closed before a render finishes it won't find it.
  - name: Sleep for 5 minutes
  run: sleep 300s
  shell: bash
 
- # Delete the branch!
- - name: Delete branch
- uses: dawidd6/action-delete-branch@v3
+ # Check out current repository
+ - name: checkout
+ uses: actions/checkout@v4
  with:
- github_token: ${{ secrets.GH_PAT }}
- branches: preview-${{ github.event.pull_request.number }}
+ fetch-depth: 0
+
+ # Delete the branch!
+ - name: Delete branch locally and remotely
+ run: git push origin --delete preview-${{ github.event.pull_request.number }} || echo "No branch to delete"