Skip to content

Commit aa5f766

Browse files
authored
Update instructions to refer to workflow templates (#27)
1 parent 992cdf7 commit aa5f766

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

R/README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,13 @@ How to create an R package for the bican-mccarroll-manuscript1 repository.
99
1. Pick `R Package`
1010
1. Give your package a name that starts with `bican.mccarroll.` (e.g., `bican.mccarroll.frob`)
1111
1. Create the project as a subdirectory `<your-git-sandbox>/bican-mccarroll-manuscript1/R`
12-
1. Set up github actions for your package by copying two workflow files (replace `frob` with your package name):
13-
- `cp .github/workflow-templates/R-package.yml .github/workflows/R-frob.yml`
14-
- `cp .github/workflow-templates/roxygen.yml .github/workflows/roxygen-frob.yml`
12+
1. Set up two GitHub Actions workflows for your package, for continuous integration and documentation generation:
13+
1. Go to Actions in your repository.
14+
1. Click on "New workflow".
15+
1. Find the `BICAN McCarroll R package Workflow` and press `Configure`.
16+
1. Follow the instructions in the workflow template.
17+
1. Find the `BICAN McCarroll Roxygen package Workflow` and press `Configure`.
18+
1. Follow the instructions in the workflow template.
1519
1. Edit these two files and replace `<package_name>` with your package name
1620
1. Do your package development as usual, including adding documentation using roxygen2.
1721
1. Create a `README.md` file in the root of your package. You can copy the one in R/bican.mccarroll.helloworld/ and modify it as appropriate.

python/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,9 @@ How to create a Python package for the bican-mccarroll-manuscript1 repository.
1616
1. Develop your package as usual, including unit tests as appropriate.
1717
1. Put a `LICENSE` file in the root of your package, and a `README.md` file in the root of your package. You can copy the ones in python/bican_mccarroll_helloworld/ and modify the README.md as appropriate.
1818
1. Create a `pyproject.toml` file in the root of your package. You can copy the one in python/bican_mccarroll_helloworld/ and modify it as appropriate.
19+
1. Set up a GitHub Actions workflow for your package:
20+
1. Go to Actions in your repository.
21+
1. Click on "New workflow".
22+
1. Find the `BICAN McCarroll python package Workflow` and press `Configure`.
23+
1. Follow the instructions in the workflow template.
1924
1. When you are ready to commit your changes, use the [basic github workflow](https://docs.google.com/document/d/1A5T8ZVhNxP0GCQmmo1R8qaPPXah9cvSLI96U3TZdYos/edit?tab=t.0) to commit and push your changes.

0 commit comments

Comments
 (0)