You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+32-48
Original file line number
Diff line number
Diff line change
@@ -1,26 +1,15 @@
1
-
---
2
-
title: Contributing
3
-
---
1
+
# Contributing
4
2
5
3
Add your extension in the `extensions/` subdirectory.
6
4
7
-
To help you get started, call `make create-extension DIR=my_extension_name` to create a new extension directory with the necessary files. Note, you will need to manually create your `manifest.json` file.
5
+
To help you get started, call `make create-extension DIR=my_extension_name` to
6
+
create a new extension directory. Note, you will need to manually create your
7
+
`manifest.json` file.
8
8
9
-
<br />
9
+
## `manifest.json`
10
10
11
-
## Required files
12
-
13
-
### `manifest.json`
14
-
15
-
Use `rsconnect` or `rsconnect-python` to generate a manifest, which is required as part of the extension bundle
16
-
17
-
### `connect-extension.qmd`
18
-
19
-
A file that has the name of your extension, the categories it falls into, and a brief description
20
-
21
-
```{filename="connect-extension.qmd"}
22
-
{{< include _template/connect-extension.qmd >}}
23
-
```
11
+
Use `rsconnect` or `rsconnect-python` to generate a manifest, which is required
12
+
as part of the extension bundle.
24
13
25
14
## Connect Gallery
26
15
@@ -41,7 +30,9 @@ in this repository.
41
30
Below is an example of the additional details that need to be manually added
42
31
to the `manifest.json`:
43
32
44
-
```json {filename="manifest.json"}
33
+
```json
34
+
// manifest.json
35
+
45
36
{
46
37
...
47
38
"extension": {
@@ -80,7 +71,9 @@ language(s) it utilizes.
80
71
81
72
Here is an example of what needs to be included in a `manifest.json`:
82
73
83
-
```json {filename="manifest.json"}
74
+
```json
75
+
// manifest.json
76
+
84
77
{
85
78
...
86
79
"environment": {
@@ -90,8 +83,7 @@ Here is an example of what needs to be included in a `manifest.json`:
90
83
"r": {
91
84
"requires": ">=4.2, <5"
92
85
}
93
-
},
94
-
...
86
+
}
95
87
}
96
88
```
97
89
@@ -110,14 +102,13 @@ To add content to the Connect Gallery, follow the steps below:
110
102
"Simple content" refers to content that can be bundled into a TAR file without
111
103
any additional steps. Most content will fall into this category.
112
104
113
-
::: {.callout-note}
114
-
If you can run
115
-
```bash
116
-
tar -czf my-extension-name.tar.gz ./extensions/my-extension-name
117
-
```
118
-
and the resulting TAR file can be published by uploading the bundle to Posit
119
-
Connect, then it is piece of simple content.
120
-
:::
105
+
> [!NOTE]
106
+
> If you can run
107
+
> ```bash
108
+
> tar -czf my-extension-name.tar.gz ./extensions/my-extension-name
109
+
>```
110
+
> and the resulting TAR file can be published by uploading the bundle to Posit
111
+
> Connect, then it is piece of simple content.
121
112
122
113
To add simple content look forthe [`simple-extension-changes` sectionin the `.github/workflows/extensions.yml`](https://github.com/posit-dev/connect-extensions/blob/main/.github/workflows/extensions.yml#L31)
123
114
file and add a new filter:
@@ -156,7 +147,7 @@ setting up the environment needed to build the content.
156
147
#### Creating a custom workflow
157
148
158
149
To facilitate control over how the content is being built we utilize custom
159
-
GitHub Workflows. See the [Creating a custom workflow](docs/creating-a-custom-workflow.qmd)
150
+
GitHub Workflows. See the [Creating a custom workflow](docs/creating-a-custom-workflow.md)
160
151
guide how to get started.
161
152
162
153
#### Calling the custom workflow
@@ -180,7 +171,9 @@ To update already released content in the Connect Gallery simply increment the
180
171
`version` field in the `extension` section of the `manifest.json` file and open
181
172
a pull request with the changes.
182
173
183
-
```json {filename="manifest.json"}
174
+
```json
175
+
// manifest.json
176
+
184
177
{
185
178
...
186
179
"extension": {
@@ -201,25 +194,16 @@ you can do that by looking in the GitHub Actions summary. Click on the "Checks"
201
194
tab for a Pull Request and then click on the Extension Workflow run and the
202
195
summary will be displayed below the workflow graph.
203
196
204
-
It will either say:
205
-
206
-
::: {.border}
207
-
The manifest version is '1.1.0' and the released version is '1.0.0'
208
-
🚀 Will release! The manifest version is greater than the released version.
209
-
:::
210
-
211
-
or:
197
+
It will say one of the following based on the `version` in the
198
+
`manifest.json` and the last released version:
212
199
213
-
::: {.border}
214
-
The manifest version is '1.0.0' and the released version is '1.0.0'
215
-
😴 Holding back from release: The manifest version is not greater than the released version.
216
-
:::
200
+
> The manifest version is '1.1.0' and the released version is '1.0.0'
201
+
> 🚀 Will release! The manifest version is greater than the released version.
217
202
218
-
or:
203
+
> The manifest version is '1.0.0' and the released version is '1.0.0'
204
+
> 😴 Holding back from release: The manifest version is not greater than the released version.
219
205
220
-
::: {.border}
221
-
⚠️ Version 0.0.0 is reserved and will never be released.
222
-
:::
206
+
> ⚠️ Version 0.0.0 is reserved and will never be released.
0 commit comments