diff --git a/.github/automatic-issues/set-repo-settings.md b/.github/automatic-issues/set-repo-settings.md index 4168399f..65861b4f 100644 --- a/.github/automatic-issues/set-repo-settings.md +++ b/.github/automatic-issues/set-repo-settings.md @@ -17,3 +17,5 @@ _After the first pull request, a couple of checks will automatically happen and - [ ] `style-n-check` is a required status check - [ ] All these settings have been saved! + +- [ ] This repo has been enrolled in [automatic updates from the original template](#receiving-automatic-mechanic-updates-from-the-original-template). diff --git a/.github/sync.yml b/.github/sync.yml old mode 100644 new mode 100755 index 63a2c5ac..fd6fd734 --- a/.github/sync.yml +++ b/.github/sync.yml @@ -5,6 +5,7 @@ group: # Repositories to recieve changes repos: | jhudsl/ITCR_Documentation_and_Usability +#ADD NEW REPO HERE following the format above# # Files which should be updated files: - .github/workflows/render-bookdown.yml @@ -15,3 +16,19 @@ group: - docker/* - scripts/* - getting_started.md + +###### TO ADD NEW REPOSITORY USE THIS FORMAT; Feel free to add/drop files that +# you specifically would like synced (or not). +# +# # Repositories to receive changes +# repos: | +# org/repo_name +# # Files which should be updated +# files: +# - .github/workflows/render-leanpub.yml +# - .github/workflows/sp-check.yml +# - .github/workflows/url-checker.yml +# - .github/workflows/ISSUE_TEMPLATES/issue_template.md +# - .github/workflows/PULL_REQUEST_TEMPLATE.md +# - scripts/* +# - getting_started.md diff --git a/.github/workflows/starting-course.yml b/.github/workflows/starting-course.yml index 007b8532..4fb67c86 100644 --- a/.github/workflows/starting-course.yml +++ b/.github/workflows/starting-course.yml @@ -53,9 +53,9 @@ jobs: run: | # Cleanup rm -rf \ - .github/workflows/downstream-mechanics-update.yml \ + .github/workflows/downstream-mechanics-updates.yml \ .github/sync.yml \ - .github/workflows/starting-template.yml \ + .github/workflows/starting-course.yml # Commit modified files - name: Commit deleted files diff --git a/getting_started.md b/getting_started.md index 72c27943..6b724c18 100644 --- a/getting_started.md +++ b/getting_started.md @@ -19,9 +19,10 @@ _Background information_: - [Recommended repository settings:](#recommended-repository-settings) - [Set up GitHub pages](#set-up-github-pages) - [Set up branches](#set-up-branches) + - [Receiving automatic mechanic updates from the original template](#receiving-automatic-mechanic-updates-from-the-original-template) - [Set up Github secrets](#set-up-github-secrets) - [Dockerhub related secrets](#dockerhub-related-secrets) - - [Google Slide related Secrets](#google-slide-related-secrets) + - [Google Slide related secrets](#google-slide-related-secrets) - [Setting up the Docker image](#setting-up-the-docker-image) - [Starting a new Docker image](#starting-a-new-docker-image) - [Adding packages to the Dockerfile](#adding-packages-to-the-dockerfile) @@ -44,6 +45,8 @@ _Background information_: - [Themes for ITCR project:](#themes-for-itcr-project) - [Accessibility](#accessibility) - [Adding images and graphics in text](#adding-images-and-graphics-in-text) +- [Adding videos in text](#adding-videos-in-text) +- [Adding embedded files to text](#adding-embedded-files-to-text) - [Learning Objectives Formatting](#learning-objectives-formatting) - [Bookdown Rendering](#bookdown-rendering) @@ -105,6 +108,14 @@ See the [Github Actions section](#github-actions) for more details on these. After setting up these new branch items, click `Create` and `Save changes`. +### Receiving automatic mechanic updates from the original template + +When updates are made to files that aren't specific to the course content but instead run checks and other processes in the original repository, PRs are filed automatically to any downstream repositories made from this template. + +To enroll in these automatic update PRs, the new course's repository name will need to be added to [this file in the original template](https://github.com/jhudsl/DaSL_Course_Template_Bookdown/blob/main/.github/sync.yml) where it says `#NEW REPO HERE#`. +File a pull request to make this change. +If the your new course doesn't need some of the functionality of these files or you find the automatic you can feel free to use [this guide](https://github.com/marketplace/actions/repo-file-sync-action#sync-the-same-files-to-multiple-repositories) to tailor which files you want updates for. + ### Set up Github secrets The Github actions that this repository uses needs four Github secrets set up. @@ -119,13 +130,15 @@ To set up these repository secrets, on your repository's main Github page, go to For each new secret, click the `New repository secret` button and set each as follows, clicking `Add secret` as you fill each in appropriately: -_Name: `GIT_TOKEN`_: +_Name: `GH_PAT`_: +*If you are a part of `jhudsl` organization you do not need to set these. For `value`: Create a personal access token [following these instructions](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token#creating-a-token). Underneath `Select scopes`, check both `repo` and `workflow`. Then copy the PAT and save as the value. #### Dockerhub related secrets Note these are not required if [Docker update Github actions are not turned on](#about-customizing-render-bookdownyml-also-called-build-all). +*If you are a part of `jhudsl` organization you do not need to set these. _Name: `DOCKERHUB_USERNAME`_: For `value`: put your login username for https://hub.docker.com/