-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathindex.qmd
165 lines (123 loc) · 3.84 KB
/
index.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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
---
pagetitle: "PharmaDevOps"
page-layout: custom
section-divs: false
editor: source
sidebar: false
search: false
description: The home of the PharmaDevOps PhUSE Working Group.
image: assets/PharmaDevOps.png
listing:
- id: cicdworkflows-minimum
contents:
- /content/cicdworkflows-minimum
- "!index.qmd"
sort: "date desc"
type: grid
categories: true
sort-ui: false
filter-ui: false
max-items: 24
feed: false
- id: cicdworkflows-recommend
contents:
- /content/cicdworkflows-recommend
- "!index.qmd"
sort: "date desc"
type: grid
categories: true
sort-ui: false
filter-ui: false
max-items: 24
feed: false
- id: cicdworkflows-enhanced
contents:
- /content/cicdworkflows-enhanced
- "!index.qmd"
sort: "date desc"
type: grid
categories: true
sort-ui: false
filter-ui: false
max-items: 24
feed: false
toc: false
---
<!--# Top welcome box -->
::: {.content-container}
::: {.top-story .blue-background}
::: grid
::: {.g-col-12 .g-col-lg-8 .top-story-text}
## Welcome to the home of **PharmaDevOps**
This PHUSE working group is focussed on ensuring R package authors new
to concepts like CICD can
can easily add these useful automations to pharmaverse R packages
and related biostatistical packages.
We hope to both
convince package developers of the value of CICD,
provide a minimum bar of what is expected, and provide a
set of tools to make it easy to implement.
:::
::: {.g-col-12 .g-col-lg-4 .top-story-img}
{width=70% fig-align="center"}
:::
:::
:::
:::
<!--# Notes on getting started -->
::: {.content-container}
::: {.top-story}
::: grid
::: {.g-col-12 .top-story-text}
## Getting started with CICD
In this guidance, you'll see a number of `gh-actions` that you can use to implement CICD on your project. We have categorised these into three groups:
- *Minimum CICD*: These are the minimum CICD tools we recommend for all packages, including those in the `pharmaverse` and `openstatsware`. These CICD tools are focussed on ensuring your package works, and the documentation users see matches the latest release of your code.
- *Recommended CICD*: These are tools we feel make your life developing and releasing robust code easier.
- *Enhanced CICD*: These are tools are option tools for power users, or those with specific needs.
Each CICD action is described via a common pattern, with an emphasis on why we recommend it, and how to use it.
A recomended plan for success in implenting CICD on your project is to:
- [Read this post](post/posts/gh-actions.html) on the general anatomy of a `gh-action`
- Browse our recomended `gh-action`'s below
- Implement CICD on your git repo!
We've also collected togther [this list of external learning resources](post/posts/external-resources.html).
:::
:::
:::
:::
<!--# Latest add-gh actions -->
::: {.content-container}
::: {.listing-block}
<a href="/content/cicdworkflows-minimum/index.qmd">
## Minimum CICD
The following CICD is what we consider a minimum bar for a
package on the pharmaverse. These CICD tools are focussed on
ensuring your package works, and documentation matches the code.
There is no need to use the specific code we suggest, if you are happy getting
the same functionality from another source, like the ones
built into `usethis`.
</a>
::: {#cicdworkflows-minimum}
:::
:::
:::
::: {.content-container}
::: {.listing-block}
<a href="/content/cicdworkflows-recommend/index.qmd">
## Recommended CICD
The following CICD are tools we feel make your life developing and
releasing robust code easier.
</a>
::: {#cicdworkflows-recommend}
:::
:::
:::
::: {.content-container}
::: {.listing-block}
<a href="/content/cicdworkflows-enhanced/index.qmd">
## Enhanced CICD
The following CICD are tools are optional tools for power users.
</a>
::: {#cicdworkflows-enhanced}
:::
:::
:::