Skip to content

Commit

Permalink
Get staging up to date (#570)
Browse files Browse the repository at this point in the history
* Revert "updating templates_to_edit image"

This reverts commit f95a790.

forgot I was on main#

* Revert "updating issue pics"

This reverts commit fbc1c3e.

forgot I was on main

* Add report-maker.yml here.  (#512)

* delete report.maker.yml

* Add report-maker.yml here

* Need to add + 1 because the column names don't count

* change strategy for declaring error_min

* Try to fix syntax around inputs.error_min

* Try this

* Update report-maker.yml

* substract 1

* Forgot to delete old attempt

* Try to fix chk_results declarations

* Get rid of straggling quote

* Print out error number

* Fix reports

* Set version

* specify git_path

* Fix file path

* Try copying over?

* ls workspace

* Nope that didn't work

* Set version

* Change version

* Check all the urls

* Don't need to specify git_path

* force pass true

* exclude docs and manuscript folder

* exclude files

* try to add Rmd

* Write our own url-checking script and get away from using url-checker-actions (#515)

* Add url-checker to docker image

* Add url-check.R adds!

* Revert "Add url-checker to docker image "

This reverts commit fe5c7ed.

* Update report-maker.yml

* Add course formats bullet point template (#516)

* Add course formats bullet points to template

* Also add ottrpal to dictionary.txt

* Render bookdown

* Update scripts so url check is fixed (#518)

* Update scripts

* try to fix url checker

* Add a broken url as a test

* rearrange steps

* get rid of -1

* get rid of extra stuff

* Fix results Thing

* Fix file path

* .csv -> .tsv

* Revert "Add a broken url as a test"

This reverts commit 973453f.

* Add files via upload

* Add ability to ignore a url in the url checker (#520)

* Try to ignore some urls

* If there's not a file, then download it

* Fix some things

* Test deleting the files

* Revert "Test deleting the files"

This reverts commit b8707f0.

* Delete report-maker.yml

* Fix false URL finds

* Fix false URL finds (#521)

* Update ignore-urls.txt

* Update url-check.R

* Try to fix url identifier

* More polishing to url-check.R

* Polishing polishing

* A few more regex refinings

* Update sync.yml (#522)

* Polishing url-check.R (#523)

* Fix false URL finds

* Try to fix url identifier

* More polishing to url-check.R

* Polishing polishing

* A few more regex refinings

* Update to stop url at }

* Fix }

* Boxes (#524)

* Revert "updating templates_to_edit image"

This reverts commit f95a790.

forgot I was on main#

* Revert "updating issue pics"

This reverts commit fbc1c3e.

forgot I was on main

* adding ITN style code for boxes

* adding images and general style code for boxes

* showing examples of style boxes

* Render bookdown

* Boxes (#525)

* Revert "updating templates_to_edit image"

This reverts commit f95a790.

forgot I was on main#

* Revert "updating issue pics"

This reverts commit fbc1c3e.

forgot I was on main

* adding ITN style code for boxes

* adding images and general style code for boxes

* showing examples of style boxes

* moving images from assets to subdir called box_images to allow for easy sync of these images

* forgot about dictionary image

* updating paths for style.css file for general template use

* updating paths for itn style doc

* adding asset box image dir to sync

* add boxes to GDSCN css code

* adding boxes to AnVIL css code

* adding boxes to DataTrail css

* Render bookdown

* make AnVIL_Template group in sync.yml

* Revert "make AnVIL_Template group in sync.yml"

This reverts commit 4490781.

* make an AnVIL_Template group in sync.yml (#527)

* Boxes (#529)

* Revert "updating templates_to_edit image"

This reverts commit f95a790.

forgot I was on main#

* Revert "updating issue pics"

This reverts commit fbc1c3e.

forgot I was on main

* adding ITN style code for boxes

* adding images and general style code for boxes

* showing examples of style boxes

* moving images from assets to subdir called box_images to allow for easy sync of these images

* forgot about dictionary image

* updating paths for style.css file for general template use

* updating paths for itn style doc

* adding asset box image dir to sync

* add boxes to GDSCN css code

* adding boxes to AnVIL css code

* adding boxes to DataTrail css

* adding initial version of reflection box

* adding reflection box to other style sets

* Update sync.yml (#526)

* Update sync.yml

* Edit Credits section

* Render bookdown

* Render bookdown

* Update sync.yml (#530)

* Update sync list for AnVIL_Template (#538)

Subscribing to `style.css` so we can get updates like those nice new style boxes!

* Branches sometimes overwrite each other - trying to fix (#537)

* Try to update the git push

* Add broken urls and spelling errors

* This appears to work better

* Revert "Add broken urls and spelling errors"

This reverts commit b4b49e6.

* clean and consolidate styling for callout boxes (#541)

* clean and consolidate styling for callout boxes

* remove old style boxes entirely

* Render bookdown

* Update transfer-rendered-files.yml - specify docker image  (#542)

* Try to update the git push

* Add broken urls and spelling errors

* This appears to work better

* Update transfer-rendered-files.yml

* Revert "Add broken urls and spelling errors"

This reverts commit b4b49e6.

* Update to ottrpal:latest to test

* temporarily turn on leanpub

* forgot the jhudsl/ part

* Don't specify latest

* Fix spec

* Switch to main

* restore default options

* fixing rendering of rest of ch 2

* adding more inform about header sytax and syntax in general, as well as more about stylized boxes.

* adding back the borders to the boxes that got removed

* trying to add back doc file

* trying to add back doc file

* trying to add back doc files

* trying to add back doc files for docs/coursera

* trying to add back doc files for docs/no_toc

* trying to add back doc files for docs/404.html

* trying to add back doc files for docs/

* trying to add back doc files for Course_Name.rds

* trying to add back doc files for book.bib

* updating spelling

* adding more structure for subheadings and more information

* adding more documentation and updating pdf example

* updating readme to include rendered version

* adding rendered link

* Render bookdown

* Add styler to render all workflow

* Revert "Add styler to render all workflow"

This reverts commit e24bf2d.

* Update ignore-urls.txt

* Add git config to address no commit

* Add ugly code to test

* Add explicit git checkout

* Add branch name for origin

* Try this

* Fix branch declaration

* Fix that

* Try REF_NAME

* head_ref

* Style Rmds

* Add styler to render all workflow (#546)

* Update README.md

* Add ottr-fy.R script

* Update README.md

* Update README.md

* Add latest ottr-fy.R script

* Update with bookdown option

* Bump create-issue-from-file action (#552)

* Delete style-sets/AnVIL directory (#553)

* Render bookdown

* Remove AnVIL repos from sync

* Update sync.yml (#554)

* Create super bare bones theme for fhdasl stuff

* Remove fhdasl_style from path

* Add things to dictionary

* remove GDSCN style-set

* Render bookdown

* Render bookdown

* Get rid of archive of spelling results

* Add docker-test here

* Delete the docker files here 

because they are managed in ottr-docker

* Get 404s properly (#564)

* Get 404s

* Restore to failed/success so downstream works

* Need some more logic

* Minor fix

* SHouldn't have https://jhudatascience.org/{Course_Name} anymore anyway

* Add pull-request.yml to use report-maker.yml here (#513)

* Update Staging branch with what's in main (#438)

* Return to pre-gist method of spell check (#409)

* Return to pre-gist method of spell check

* Get rid of gist stuff on delete-preview too

* Temporarily add spelling errors to test

* Commit before testing

* Switch to use -z

* Fix git diff step

* Just look at the local main since it should be up to date

* make it simple

* Get rid of double bracket

* No brackets?

* Revert "Temporarily add spelling errors to test"

This reverts commit 9e9a932.

* Update screenshot for new repo (#410)

* Update template button screenshot (#411)

* Update screenshot for new repo

* Update template button too

* See if `fetch-depth: 0` fixes the shallow problem (#412)

* Update screenshot for new repo

* Update template button too

* fetch it all

* Switch to devtools::session_info()

* Render bookdown

* Update screenshot for git-secret.png (#414)

* Update screenshot for git-secret.png

* Crop off irrelevant git secrets

* syntax updates

* Needed a semicolon

* Fix branch handling

* Update spell check set up

* Update main

* add brackets

* set shell intentionally

* fix if statements

* Create PR if it can't push directly

* Make sure it merges

* Alter branch test

* quote the 0?

* switch to -z

* Delete extra then

* This should work

* Change to preview- again whoops

* Add a push step

* Update starting course

* set upstream

* Set to bash intentionally (#419)

* set to bash

* Update

* no workflow dispatch

* Test leanpub from here (#420)

* Test leanpub from here

* Update comments

* Add check quizzes too

* Couple edits

* Shut them off for now

* Update comments

* Render leanpub

* Minor polishing of steps (#421)

* Test leanpub from here

* Update comments

* Add check quizzes too

* Couple edits

* Shut them off for now

* Update comments

* Note which places needed to be uncommented

* Just making the step clearer

* Add a git fetch

* Add quizzes to spell check

* Update README.md

* Render leanpub

* Add new repository to sync

* Polish Examples in Rmds (#426)

* Echo false in examples

* Updating wiki

* Render bookdown

* Render bookdown (#427)

* Prep for ottr rename (#428)

* Render bookdown

* Make docker unfail (#431)

* Make docker not fail

* Add Dockerfile example

* Get rid of extra line

* Skip build for this test

* comment out push part too for this test

* undo test Dockerfile

* Render bookdown

* Try out screenshot creator as a part of the new Leanpub set up  (#422)

* Try out screenshot creator

* Fix spacing

* Get rid of typo

* fix argument spec

* Fix git pat handling

* Add copy over assets step

* Try this

* Try installing just the packages we need

* Add install of remotes

* Try using devtools instead

* try set environ

* Try to install R first

* Add prereqs

* Try rocker r-base

* Put installations in script

* Try different strategy

* Switch to tidyverse

* Make directory in bash

* I guess I'm making this its own docker image

* This isn't working but I want it in case I come back to it

* Switch to wkhtmltopdf

* Lets' try it

* Trying leanbuild steps on their own dockerfile

* Test build of leanbuild docker image

* Try out webshot r package

* fix file path to script

* Oh. Actually fix it

* Try installing webshot::install_phantomjs

* Try installing phantomjs on its own first

* Set this up

* Build from jhudsl/course_template

* Switch back to main dockerfile

* assets problem

* It works!

* Revert "assets problem"

This reverts commit 2aada9b.

* Add markdown maker basics

* Push this version before I delete things

* Clean up

* Delete the pdfs

* Reconfig with latest ottr package changes

* Turn on render again

* Add PR instead

* Move copying step

* Add an :: that was missing

* Fix arguments for getting pages url

* misplaced quotes

* Add make_book_txt = TRUE

* It's working! Undo the commenting part

* Set base to main

* Revert "It's working! Undo the commenting part"

This reverts commit 92e5081.

* rm manuscript folder

* Just commit to main

* Delete old manuscript files

* Copy over assets

* Render bookdown

* Remove manuscript if it is there

* Set group and user id to get rid of permissions probs

* Forgot \ 's

* Render bookdown

* Make it force push

* only force manuscript dir

* Render Leanpub

* Render Leanpub

* Render Leanpub

* Add to transfer PRs

* Delete manuscript folder

* Add to sync.yml

* Render Leanpub

* Remove _Template bit

* Add coursera bit and _Quizzes

* Clean out manuscript folder when starting new course

* Make transfers go to the right folder

* add /

* Update sync.yml with OTTR_Template_Website (#437)

Co-authored-by: jhudsl-robot <itcrtrainingnetwork@gmail.com>

Co-authored-by: GitHub Actions <actions@github.com>
Co-authored-by: jhudsl-robot <97678365+jhudsl-robot@users.noreply.github.com>
Co-authored-by: Tiffany Miller <tiffanym@broadinstitute.org>
Co-authored-by: jhudsl-robot <itcrtrainingnetwork@gmail.com>

* Delete packages.bib

* Minor edits to index.Rmd

* Delete extraneous files

* Consolidate and config a pull request GHA  (#448)

* Create config_automation.yml

* Update style-and-sp-check.yml

* Update the filename 😑

* Checking dependency

* Update style-and-sp-check.yml

* Testing that file is carried over

* Add toggle to second check

* Change config to test

* Test removal of some extra text

* Change config to test (again)

* Update config_automation.yml

* What does the output look like with more checks added?

* Fix spacing

* Forgot "steps:"

* BIG YAML

* Get rid of other ones

* Fix names

* Add needs

* Try adding docker to it

* Fix syntax

* Gotta check it out first

* Extra "if" lying around

* Set logically differently

* Testing change

* Add Ava's suggestions!

Co-authored-by: AM Hoffman <avamariehoffman@gmail.com>

* Consolidate and config a rendering GHA  (#449)

* Create config_automation.yml

* Update style-and-sp-check.yml

* Update the filename 😑

* Checking dependency

* Update style-and-sp-check.yml

* Testing that file is carried over

* Add toggle to second check

* Change config to test

* Test removal of some extra text

* Change config to test (again)

* Update config_automation.yml

* What does the output look like with more checks added?

* Fix spacing

* Forgot "steps:"

* BIG YAML

* Get rid of other ones

* Fix names

* Add needs

* Try adding docker to it

* Make a render-all yaml

* Fix syntax

* Gotta check it out first

* Extra "if" lying around

* Set logically differently

* Echo no branch to delete if there is none to delete

* Update sync.yml

* fix syntax

* Fix name of render-all

* Add names

Co-authored-by: AM Hoffman <avamariehoffman@gmail.com>

* Update pull-request.yml to use report-maker.yml

* Need to add + 1 because the column names don't count

* Turn on quiz check for testing

* Add comment

* Try out different syntax for + 1

* Add errors to test

* Add a quiz error

* Add url error

* Make quiz error

* Add question error

* Add URL

* Switch version of url-checker

* Add url-checker to docker image

* Add url-check.R adds!

* Update report-maker.yml

* fix script

* Get rid of fake errors

* Revert "Add question error"

This reverts commit dc411cb.

* Fix quiz

* Add a correct answer

* Stop checking quizzes

* Try out new github action

* Fix indents

* Try this out?

* Fix comments

* git force --add

* Updates

* Get rid of secrets:

* Try ottr-reports set up

* Get rid of secrets.

* Test secrets.GH_PAT

* Ignore checks for testing purposes

* Try secrets.GH_PAT again

* Try supplying secret through environment

* Switch order of steps

* Try somewhere else

* use ls- R again

* Try again

* Re-run without script directory perl thing

* Try $GITHUB_WORKSPACE

* Maybe we need to check out files in report_maker

* Use basename

* Try to fix syntax

* Name output variable in earlier step

* Declare report name

* Add error URL

* Fix error url

* Drop quotes and {}

* echo it maybe

* add more explicit variable declaration

* Drop brackets

* no quotes

* Try to fix quotes

* Try quotes

* Try `contains()`

* Commit reports to the branch

* Try to supply token

* add secrets designation

* Use V3 checkout

* switch gh_pat designation

* login as jhudsl-robot

* Move the steps:

* No login

* Specify GH_PAT

* Try this instead

* Try environment thing

* Revert "Try environment thing"

This reverts commit ac469b8.

* Don't set inputs.gh_pat

* set git config

* Try to fix error 11

* Fix an inputs.gh_pat

* specify ref

* Adjust the logic

* git add adjust

* Add errors to check that this is working

* Try again

* Calculate error number by hand

* Declare number of errors

* Try this instead

* Forgot a $

* Try to fix number thing

* Still trying to fix error count

* print out error numbers

* Add spelling errors

* Try to set up the error_num another way

* Print out error numbers

* Remove errors and see if this works

* Fix branch merge option

Co-authored-by: GitHub Actions <actions@github.com>
Co-authored-by: jhudsl-robot <97678365+jhudsl-robot@users.noreply.github.com>
Co-authored-by: Tiffany Miller <tiffanym@broadinstitute.org>
Co-authored-by: jhudsl-robot <itcrtrainingnetwork@gmail.com>
Co-authored-by: AM Hoffman <avamariehoffman@gmail.com>

* Call report-maker.yml from here (#565)

* Call report-maker.yml from here

* Delete report-maker.yml from this repo

* Update links in automatic issues (#567)

* Update links in automatic issue set-repo-settings

* remove duplicate GH_PAT

* update more links

* Update links in update-enrollment.md

* update templates-to-edit

* Update all refs to Wiki with new stuff

* Update link in .github/automatic-issues/templates-to-edit.md

* Update another link in .github/automatic-issues/set-repo-settings.md

* another link

* another link

Co-authored-by: Candace Savonen <cansav09@gmail.com>

* Render bookdown

* switch the name and refs of course_template to base_ottr (#569)

* switch to base_ottr

* Ad to config_automation.yml

* Replace all instances of "jhudsl/course_template" -> "jhudsl/base_ottr"

* Render bookdown

* Update sync.yml

Co-authored-by: Carrie Wright <cwrigh60@jhu.edu>
Co-authored-by: jhudsl-robot <itcrtrainingnetwork@gmail.com>
Co-authored-by: Carrie Wright <23014755+carriewright11@users.noreply.github.com>
Co-authored-by: Katherine Cox <katherinecox@jhu.edu>
Co-authored-by: avahoffman <avamariehoffman@gmail.com>
Co-authored-by: GitHub Actions <actions@github.com>
Co-authored-by: jhudsl-robot <97678365+jhudsl-robot@users.noreply.github.com>
Co-authored-by: Tiffany Miller <tiffanym@broadinstitute.org>
  • Loading branch information
9 people authored Oct 6, 2022
1 parent 8fff761 commit 296fb2f
Show file tree
Hide file tree
Showing 84 changed files with 1,763 additions and 1,448 deletions.
10 changes: 5 additions & 5 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,17 @@

- [ ] New content/chapter is in an Rmd file with [this kind of format and headers](https://github.com/jhudsl/OTTR_Template/blob/main/02-chapter_of_course.Rmd).

- [ ] New content/chapter contains [Learning Objectives and are in the correct format](https://github.com/jhudsl/OTTR_Template/wiki/Setting-up-images-and-graphics#learning-objectives-formatting).
- [ ] New content/chapter contains learning objectives.

- [ ] [Bookdown successfully re-renders and any new content files have been added to the _bookdown.yml](https://github.com/jhudsl/OTTR_Template/wiki/Publishing-with-Bookdown).

- [ ] Spell check runs successfully in [Github actions style-n-check](https://github.com/jhudsl/OTTR_Template/wiki/How-to-set-up-and-customize-GitHub-actions-robots#spell-check)).
- [ ] [Spell check runs successfully](https://www.ottrproject.org/customize-robots.html#Spell_checking)).

- [ ] Any newly necessary packages that are needed have been added to the [Dockerfile and image](https://github.com/jhudsl/OTTR_Template/wiki/Using-Docker#adding-packages-to-the-dockerfile).
- [ ] Any newly necessary packages that are needed have been added to the [Dockerfile and image](https://www.ottrproject.org/customize-docker.html).

- [ ] Images are in the [correct format for rendering](https://github.com/jhudsl/OTTR_Template/wiki/Setting-up-images-and-graphics#adding-images-and-graphics-in-text).
- [ ] Images are in the [correct format for rendering](https://www.ottrproject.org/writing_content.html#set-up-images).

- [ ] Every new image has [alt text and is in a Google Slide](https://github.com/jhudsl/OTTR_Template/wiki/Setting-up-images-and-graphics#accessibility).
- [ ] Every new image has [alt text and is in a Google Slide](https://www.ottrproject.org/writing_content.html#Accessibility).

- [ ] Each slide is described in the notes of the slide so learners relying on a screen reader can access the content. See https://lastcallmedia.com/blog/accessible-comics for more guidance on this.

Expand Down
2 changes: 1 addition & 1 deletion .github/automatic-issues/add-feedback-method.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@

To help users report issues or areas of improvement for your course, you should provide a clear method of feedback for your users to route their concerns through.

[See these instructions](https://github.com/jhudsl/OTTR_Template/wiki/Set-up-feedback-method) for suggestions on how to add a feedback method for this course.
[Read this chapter from an OTTR-made course about how to obtain user feedback](https://jhudatascience.org/Documentation_and_Usability/obtaining-user-feedback.html).
8 changes: 0 additions & 8 deletions .github/automatic-issues/add-to-library.md

This file was deleted.

4 changes: 2 additions & 2 deletions .github/automatic-issues/git-secrets.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@

**Note these steps are only pertinent if you are setting up this course outside of the jhudsl organization**

For more information on these settings see instructions in the [getting started GitHub wiki pages](https://github.com/jhudsl/OTTR_Template/wiki/Setting-up-GitHub-secrets).
For more information on these settings see instructions in the [getting started on ottrproject.org](https://www.ottrproject.org/getting_started.html#6_Set_up_your_GitHub_personal_access_token).

It's important that these are set up and named exactly what they are below in order for Github actions to work correctly.

To set up these repository secrets, on your repository's main Github page, go to `Settings` and scroll down to see `Secrets` on the left side menu bar.

- [ ] Set `GH_PAT`
`Name`: `GH_PAT`
`value`: A personal access token [following these instructions](https://github.com/jhudsl/OTTR_Template/wiki/Start-a-new-course#6-set-up-your-github-personal-access-token).
`value`: A personal access token [following these instructions](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/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.
10 changes: 5 additions & 5 deletions .github/automatic-issues/images-checklist.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@

Use this checklist to make sure your slides and images are set up correctly!

See [Setting Up Images and Graphics](https://github.com/jhudsl/OTTR_Template/wiki/Setting-up-images-and-graphics) for more info!
See [Setting Up Images and Graphics](https://www.ottrproject.org/writing_content.html#set-up-images) for more info!

- [ ] Create your [course's main Google Slides](https://github.com/jhudsl/OTTR_Template/wiki/Setting-up-images-and-graphics)
- [ ] Create your course's main Google Slides.

- [ ] The slides use the [appropriate template](https://github.com/jhudsl/OTTR_Template/wiki/Setting-up-images-and-graphics).
- [ ] The slides use the appropriate template.

- [ ] Each slide is described in the notes of the slide so learners relying on a screen reader can access the content. See https://lastcallmedia.com/blog/accessible-comics for more guidance on this.

- [ ] The color palette choices of the slide are contrasted in a way that is friendly to those with color vision deficiencies.
You can check this using [Color Oracle](https://colororacle.org/).

- [ ] Every image is [inserted into the text](https://github.com/jhudsl/OTTR_Template/wiki/Setting-up-images-and-graphics#adding-images-and-graphics-in-text) using one of these options: `ottrpal::include_slide()`, `knitr::include_image()`, or this format: `<img src="blah.png" alt="SOMETHING">`.
- [ ] Every image is inserted into the text using one of these options: `ottrpal::include_slide()`, `knitr::include_image()`, or this format: `<img src="blah.png" alt="SOMETHING">`.

- [ ] Every image has [alternative text added to it](https://github.com/jhudsl/OTTR_Template/wiki/Setting-up-images-and-graphics#adding-images-and-graphics-in-text).
- [ ] Every image has alternative text added to it.

- [ ] The beginning of each Rmd contains this chunk so the images are saved in the correct spot:

Expand Down
19 changes: 9 additions & 10 deletions .github/automatic-issues/set-repo-settings.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,24 @@

For more information on these settings see instructions in the [getting started GitHub wiki pages](https://github.com/jhudsl/OTTR_Template/wiki/Start-a-new-course).
For more information on these settings see instructions in [Starting a new OTTR course](https://www.ottrproject.org/getting_started.html#starting-a-new-ottr-course).

- [ ] This course repository is set to `public`.
- [ ] [Add the `jhudsl-robot` as a collaborator to your repository.](https://github.com/jhudsl/OTTR_Template/wiki/Setting-up-your-repository-settings#add-jhudsl-robot-as-a-collaborator).
- [ ] [GH_PAT has been set up as a GitHub secret](https://github.com/jhudsl/OTTR_Template/wiki/Start-a-new-course#6-set-up-your-github-personal-access-token)
- [ ] [Add the `jhudsl-robot` as a collaborator to your repository.](https://www.ottrproject.org/getting_started.html#5_Add_jhudsl-robot_as_a_collaborator).

- [ ] GitHub pages is turned on
- [ ] Go to `Settings` > `Pages`. Underneath `Source`, choose `main` for the branch and select the `docs` folder. Then click `Save`.
- [ ] Check `Enforce HTTPS`.

- [ ] [Github secret `GH_PAT` has been set](https://github.com/jhudsl/OTTR_Template/wiki/Start-a-new-course#6-set-up-your-github-personal-access-token)
- [ ] [Github secret `GH_PAT` has been set](https://www.ottrproject.org/getting_started.html#6_Set_up_your_GitHub_personal_access_token)
`Name`: `GH_PAT`
`value`: A personal access token [following these instructions](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/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.

- [ ] GitHub pages is turned on
- [ ] Go to `Settings` > `Pages`. Underneath `Source`, choose `main` for the branch and select the `docs` folder. Then click `Save`.
- [ ] Check `Enforce HTTPS`.

- [ ] [Set branch protections settings](https://github.com/jhudsl/OTTR_Template/wiki/Start-a-new-course#9-set-up-branch-rules)
- [ ] [Set branch protections settings](https://www.ottrproject.org/getting_started.html#8_Set_up_branch_rules)
- [ ] `main` branch has been set up:
- [ ] `Require pull request reviews before merging` box is checked.
- [ ] `Require status checks to pass before merging` box is checked.
- [ ] Underneath that `Require branches to be up to date before merging` box is checked.
- [ ] Click `Save` at the bottom of the page!

- [ ] [Customize GitHub actions](https://github.com/jhudsl/OTTR_Template/wiki/How-to-set-up-and-customize-GitHub-actions-robots) for what you will need in this course.
- [ ] [Customize GitHub actions](https://www.ottrproject.org/customize-robots.html) for what you will need in this course.
14 changes: 7 additions & 7 deletions .github/automatic-issues/templates-to-edit.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

[Follow the Wiki instructions here](https://github.com/jhudsl/OTTR_Template/wiki/Start-editing-your-course) for details on how to complete the items in this issue.
[Follow the instructions here in ottrproject.org](https://www.ottrproject.org/writing_content.html) for details on how to start editing your OTTR course

The following files need to be edited to get this new course started!

Expand All @@ -12,23 +12,23 @@ The following files need to be edited to get this new course started!

### Files that need to be edited upon adding each new chapter (including upon creating a new course):

- [ ] `_bookdown.yml` - The list of Rmd files that need to be rendered needs to be updated. See [instructions](https://github.com/jhudsl/OTTR_Template/wiki/Publishing-with-Bookdown).
- [ ] `book.bib` - any citations need to be added. See [instructions](https://github.com/jhudsl/OTTR_Template/wiki/Citations).
- [ ] `_bookdown.yml` - The list of Rmd files that need to be rendered needs to be updated. See [instructions](https://www.ottrproject.org/examples.html#publishing-with-bookdown).
- [ ] `book.bib` - any citations need to be added. See [instructions](https://www.ottrproject.org/more_features.html#citing-sources).

### Picking a style

See more [about customizing style on this page in the guide](https://github.com/jhudsl/OTTR_Template/wiki/Change-Title-&-Customize-style).
See more [about customizing style on this page in the guide](https://www.ottrproject.org/customize-style.html).
By default this course template will use the jhudsl data science lab style. However, you can customize and switch this to another style set.

#### Using a style set

[Read more about the style sets here](https://github.com/jhudsl/OTTR_Template/wiki/Change-Title-&-Customize-style#using-a-style-set).
[Read more about the style sets here](https://www.ottrproject.org/customize-style.html#Using_a_style_set).

- [ ] On a new branch, copy the `style-sets/<set-name>/index.Rmd` and `style-sets/<set-name>/_output.yml` to the top of the repository to overwrite the default `index.Rmd` and `_output.yml`.
- [ ] Copy over all the files in the `style-sets/<set-name>/copy-to-assets` to the `assets` folder in the top of the repository.
- [ ] [Create a pull request](https://github.com/jhudsl/OTTR_Template/wiki/Start-editing-your-course#getting-started-with-the-github-workflow) with these changes, and double check the rendered preview to make sure that the style is what you are looking for.
- [ ] [Create a pull request](https://www.ottrproject.org/writing_content.html#Open_a_pull_request) with these changes, and double check the rendered preview to make sure that the style is what you are looking for.

### Files that need to be edited upon adding new packages that the book's code uses:

- `docker/Dockerfile` needs to have the new package added so it will be installed. See [instructions](https://github.com/jhudsl/OTTR_Template/wiki/Using-Docker#starting-a-new-docker-image).
- `docker/Dockerfile` needs to have the new package added so it will be installed. See [instructions](https://www.ottrproject.org/customize-docker.html).
- The code chunk in `index.Rmd` should be edited to add the new package.
4 changes: 2 additions & 2 deletions .github/automatic-issues/update-enrollment.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ We are working on adding more features and smoothing out bugs as we go.

If you want to receive updates from the original template to your course template, you will need to enroll this repository to the template updates by adding it to the `sync.yml` file.

- [ ] [Follow these instructions](https://github.com/jhudsl/OTTR_Template/wiki/Start-a-new-course#9-enroll-your-repository-for-ottr-updates) to enroll your course repository to receive these updates.
- [ ] [Follow these instructions](https://www.ottrproject.org/getting_started.html#9_Enroll_your_repository_for_OTTR_updates) to enroll your course repository to receive these updates.

- [ ] [Ensure that you have followed these instructions](https://github.com/jhudsl/OTTR_Template/wiki/Start-a-new-course#5-add-jhudsl-robot-as-a-collaborator) to add the `jhudsl-robot` as a collaborator to your repository.
- [ ] [Ensure that you have followed these instructions](https://www.ottrproject.org/getting_started.html#5_Add_jhudsl-robot_as_a_collaborator) to add the `jhudsl-robot` as a collaborator to your repository.
48 changes: 40 additions & 8 deletions .github/sync.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@ group:
send-updates.yml
test-send-updates.yml
starting-course.yml
- source: scripts/
dest: scripts/
deleteOrphaned: true
release-notes.yml
- source: .github/ISSUE_TEMPLATE/course-problem-report.md
dest: .github/ISSUE_TEMPLATE/course-problem-report.md
- source: .github/ISSUE_TEMPLATE/course-content-add.md
Expand All @@ -21,22 +19,24 @@ group:
dest: scripts/make_screenshots.R
- source: scripts/spell-check.R
dest: scripts/spell-check.R
- source: scripts/url-check.R
dest: scripts/url-check.R
- source: scripts/quiz-check.R
dest: scripts/quiz-check.R
- source: scripts/git_repo_check.R
dest: scripts/git_repo_check.R
- source: code_of_conduct.md
dest: code_of_conduct.md
- source: style-sets
dest: style-sets
- source: assets/box_images/
dest: assets/box_images/
# Repositories to receive changes
repos: |
jhudsl/Documentation_and_Usability
jhudsl/Informatics_Research_Leadership
jhudsl/Data_Management_for_Cancer_Research
jhudsl/Computing_for_Cancer_Informatics
jhudsl/AnVIL_Book_Getting_Started
jhudsl/AnVIL_Book_Instructor_Guide
jhudsl/AnVIL_Book_WDL
jhudsl/AnVIL_Template
jhudsl/Adv_Reproducibility_in_Cancer_Informatics
jhudsl/Reproducibility_in_Cancer_Informatics
jhudsl/Dissemination_and_Engagement
Expand All @@ -45,10 +45,11 @@ group:
jhudsl/Cancer_Informatics_Data_Visualization
jhudsl/Cancer_Genome_Informatics
jhudsl/Cancer-Imaging-Informatics
jhudsl/GDSCN_Book_SARS_Galaxy_on_AnVIL
datatrail-jhu/DataTrail_Template
abyzovlab/CNVpytor-course
opencasestudies/OCS_Guide
tmm211/dsp-terra-mooc-test2
fhdsl/Choosing_Genomics_Tools
###ADD NEW REPO HERE following the format above#

### These are custom groups for syncing -- not all files needs to be synced
Expand Down Expand Up @@ -79,3 +80,34 @@ group:
dest: scripts/switch_sync_repo.R
repos: |
jhudsl/OTTR_Quizzes
- files:
- source: .github/workflows/
dest: .github/workflows/
exclude: |
starting-course.yml
release-notes.yml
- source: .github/switch_sync_repo.R
dest: .github/switch_sync_repo.R
- source: .github/ISSUE_TEMPLATE/course-problem-report.md
dest: .github/ISSUE_TEMPLATE/course-problem-report.md
- source: .github/ISSUE_TEMPLATE/course-content-add.md
dest: .github/ISSUE_TEMPLATE/course-content-add.md
- source: scripts/make_screenshots.R
dest: scripts/make_screenshots.R
- source: scripts/spell-check.R
dest: scripts/spell-check.R
- source: scripts/url-check.R
dest: scripts/url-check.R
- source: scripts/quiz-check.R
dest: scripts/quiz-check.R
- source: scripts/git_repo_check.R
dest: scripts/git_repo_check.R
- source: code_of_conduct.md
dest: code_of_conduct.md
- source: assets/box_images/
dest: assets/box_images/
- source: assets/style.css
dest: assets/AnVIL_style/style.css
repos: |
jhudsl/AnVIL_Template
6 changes: 3 additions & 3 deletions .github/workflows/docker-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ jobs:
load: true
context: docker
file: docker/Dockerfile
tags: jhudsl/course_template
tags: jhudsl/base_ottr

# Login to Dockerhub
- name: Login to DockerHub
Expand All @@ -74,5 +74,5 @@ jobs:
- name: Push Docker image if manual trigger set to true
if: ${{ github.event.inputs.dockerhubpush != 'false' }}
run: |
docker tag jhudsl/course_template:latest jhudsl/course_template:$github.event.inputs.tag
docker push jhudsl/course_template:$github.event.inputs.tag
docker tag jhudsl/base_ottr:latest jhudsl/base_ottr:$github.event.inputs.tag
docker push jhudsl/base_ottr:$github.event.inputs.tag
90 changes: 90 additions & 0 deletions .github/workflows/docker-test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@

# Candace Savonen Apr 2022

name: Build Docker Image

on:
workflow_dispatch:
inputs:
directory:
required: true
type: string
tag:
required: true
type: string
dockerhubpush:
description: 'Push to Dockerhub?'
required: false
default: 'false'
type: string
secrets:
GH_PAT:
required: true
DOCKERHUB_USERNAME:
required: false
DOCKERHUB_TOKEN:
required: false

jobs:

build-docker:
name: Build Docker image
runs-on: ubuntu-latest

steps:
- name: checkout repo
uses: actions/checkout@v2

- name: Verify Dockerfiles changed?
uses: tj-actions/verify-changed-files@v8.8
id: verify-changed-files
with:
files: |
${{ inputs.directory }}/Dockerfile
${{ inputs.directory }}/github_package_list.tsv
- name: Login as jhudsl-robot
run: |
git config --local user.email "itcrtrainingnetwork@gmail.com"
git config --local user.name "jhudsl-robot"
# Set up Docker build
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1

# Setup layer cache
- name: Cache Docker layers
uses: actions/cache@v2
with:
path: /tmp/.buildx-cache
key: ${{ runner.os }}-buildx-${{ github.sha }}
restore-keys: |
${{ runner.os }}-buildx-
- name: Set up Docker Build
uses: docker/setup-buildx-action@v1

- name: Get token
run: echo ${{ secrets.GH_PAT }} > ${{ inputs.directory }}/git_token.txt

- name: Build Docker image
uses: docker/build-push-action@v2
with:
push: false
load: true
context: ${{ inputs.directory }}
file: ${{ inputs.directory }}/Dockerfile
tags: ${{ inputs.tag }}

# Login to Dockerhub
- name: Login to DockerHub
if: ${{ inputs.dockerhubpush != 'false' }}
uses: docker/login-action@v1
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}

# Push the Docker image if set to true from a manual trigger
- name: Push Docker image if manual trigger set to true
if: ${{ inputs.dockerhubpush != 'false' }}
run: docker push ${{ inputs.tag }}
Loading

0 comments on commit 296fb2f

Please sign in to comment.