Skip to content

Receiving template updates

Candace Savonen edited this page Sep 21, 2021 · 18 revisions

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 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 to tailor which files you want updates for.

Carefully review the sync PR before merging it! It might be that you want some of the changes from the PR but not all of them. Each file that is updated in a sync PR is updated in its own commit.

How to tailor the sync PR changes:

Upon a new release, a PR is automatically filed to any repositories that are added to the sync.yml file Carefully review the latest release notes and the Files changed tab of the sync PR.

  • If you don't want the changes from a particular file, you can always revert that particular commit before merging the sync PR.
    If you will not want any updates on this file in the future, you may want to remove a file from being synced in your repo by reconfiguring the sync file.

  • If you want only some changes, but they are not on a whole file basis, you could check out the branch and make manual edits. To checkout the branch, navigate to your own repository you should be able to run:

git checkout repo-sync/DaSL_Course_Template_Bookdown/default
Clone this wiki locally