-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.qmd
111 lines (78 loc) · 3 KB
/
README.qmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
---
format: gfm
---
<!-- README.md is generated from README.qmd. Please edit that file -->
# CCBR actions 🤖
GitHub Actions for CCBR repos
[](https://github.com/CCBR/actions/actions/workflows/build-python.yml)
[](https://codecov.io/gh/CCBR/actions)
[](https://doi.org/10.5281/zenodo.13761059)
## Examples
See [examples/](examples) for workflow examples.
You can copy these to your own repository in the `.github/workflows/` directory
and modify them for your needs.
```{python}
#| output: asis
#| echo: false
import pathlib
for path in sorted(pathlib.Path('examples').glob('*.yml')):
print(f"- [{path.stem}]({path})")
```
View the [GitHub Actions docs](https://docs.github.com/en/actions) for more
information on how to write and use GitHub Actions workflows.
## Actions
Custom actions used in our github workflows.
```{python}
#| output: asis
#| echo: false
import yaml
for action_yml in sorted(pathlib.Path().glob("*/action.yml")):
with action_yml.open('r') as infile:
action_meta = yaml.load(infile, Loader = yaml.FullLoader)
name = action_meta['name']
desc = action_meta['description']
print(f"- [{name}]({action_yml.parent}) - {desc}")
```
## Package
This repo contains a python package with helper functions for some of our
custom actions.
You do not need to install anything in order to use the example workflows,
as the actions install their dependencies as needed.
However, you can install the package if you wish to use it outside of GitHub Actions.
### Installation
You will need the GitHub CLI installed
(this is pre-installed on all github actions runners):
<https://github.com/cli/cli#installation>
Then install the `ccbr_actions` package with pip:
```bash
pip install git+https://github.com/CCBR/actions
```
Or install it from a specific version or branch with:
```bash
pip install git+https://github.com/CCBR/actions@v0.1
```
View the package documentation [here](https://CCBR.github.io/actions/reference).
## Help & Contributing
Come across a **bug**? Open an
[issue](https://github.com/CCBR/actions/issues) and include a minimal
reproducible example.
Have a **question**? Ask it in
[discussions](https://github.com/CCBR/actions/discussions).
Want to **contribute** to this project? Check out the [contributing
guidelines](.github/CONTRIBUTING.md).
## Citation
Please cite this software if you use it in a publication:
```{python}
#| echo: false
#| output: asis
!ccbr_tools cite CITATION.cff -f apalike | sed -E 's/^/> /g'
```
### Bibtex entry
```{python}
#| echo: false
!ccbr_tools cite CITATION.cff -f bibtex
```
## Inspiration
This project was inspired by [r-lib/actions](https://github.com/r-lib/actions/)
and [{usethis}](https://usethis.r-lib.org/reference/github_actions.html).
Check them out for actions, workflows, and helper functions for R packages!