Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
apulsipher authored Feb 11, 2025
1 parent 0ef3472 commit 8ea7266
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,24 @@ This file can also be freely customized to your needs.

[**`run-forecast.yml`**](./.github/workflows/run-forecast.yml) contains the GitHub Actions workflow for running the forecast automatically.
This includes setting the schedule and uploading the HTML forecast report to GitHub Pages, which is what you will most likely be modifying for your project.
Take careful consideration before modifying anything other than the schedule and publishing destination to avoid breaking the workflow.
Take careful consideration before modifying anything other than the container, the schedule, and publishing destination to avoid breaking the workflow.
Also, **note** that while this workflow will work immediately after copying the template repository (and will be available under "Deployments"), the website URL won't be immediately visible on the main repo page.
This can be added by editing the "About" section (clicking the gear icon) and checking the box for "Use your GitHub Pages website".

[**`Dockerfile`**](./.devcontainer/Dockerfile) defines the Docker image for running the forecast.
This should contain all the packages you need for your forecast (e.g., `epiworldR`, `ggplot2`, etc.).
We have a separate GHA workflow file for [building the Docker image](./.github/workflows/build-docker-image.yml) from the Dockerfile so it can be used by the GHAs.
Once you copy the template repository, the `build-docker-image` workflow will create the Docker image for your new repository.
Consequently, you'll need to modify the [container in `run-forecast.yml`](https://github.com/EpiForeSITE/epiworld-forecasts/blob/0ef3472bd5084bb3a95a646e07d218cd2154725a/.github/workflows/run-forecast.yml#L36) to the newly built docker image:
```
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest
container: ghcr.io/epiforesite/epiworld-forecasts -> change to "ghcr.io/<your_org_name>/<your_repo_name>"
permissions:
contents: write
```
Otherwise, your project will continue to use our `epiworld-forecasts` Docker image.

Our example features additional [Methodology](./methodology.qmd) and [About](./about.qmd) pages, but these are not required for your project.
Adjust the global website settings in the [`_quarto.yml`](./_quarto.yml) file.
Expand Down

0 comments on commit 8ea7266

Please sign in to comment.