Skip to content

Commit c21fa04

Browse files
authored
add directions to use p3m (#157)
1 parent 8857a70 commit c21fa04

File tree

1 file changed

+23
-8
lines changed

1 file changed

+23
-8
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,21 @@ create a new extension directory. Note, you will need to manually create your
1111
Use `rsconnect` or `rsconnect-python` to generate a manifest, which is required
1212
as part of the extension bundle.
1313

14+
## Use the Posit Public Package Manager as your R package repository
15+
16+
Before you work with R content, set the Posit Public Package Manager as your R
17+
package repository. Put the following in your `~/.Rprofile`:
18+
19+
```r
20+
options(repos = c(CRAN = "https://packagemanager.posit.co/cran/latest"))
21+
```
22+
23+
It's best to do this this *before* you install packages, run `renv::init()` or
24+
`renv::restore()`, or generate a `manifest.json`. Doing this allows content to
25+
use binary packages when it installs on a Connect server.
26+
27+
See https://packagemanager.posit.co/client/#/repos/cran/setup for more detail.
28+
1429
## Connect Gallery
1530

1631
The Connect Gallery displays apps, dashboards, and reports that can be easily
@@ -124,7 +139,7 @@ The `requiredFeatures` field in the `extension` section of the `manifest.json`
124139
is optional, but if your content requires enhanced features of Posit Connect to
125140
function correctly it should be included.
126141

127-
For example, if your content requires the API Publishing feature your
142+
For example, if your content requires the API Publishing feature your
128143
`manifest.json` should include the following:
129144

130145
```json
@@ -290,17 +305,17 @@ Connect Gallery.
290305
### Checking if your extension will release
291306
292307
If you would like to check if merging a pull request will trigger a new release
293-
you can do that by looking in the GitHub Actions summary. Click on the "Checks"
294-
tab for a Pull Request and then click on the Extension Workflow run and the
308+
you can do that by looking in the GitHub Actions summary. Click on the "Checks"
309+
tab for a Pull Request and then click on the Extension Workflow run and the
295310
summary will be displayed below the workflow graph.
296311
297312
It will say one of the following based on the `version` in the
298313
`manifest.json` and the last released version:
299314
300-
> The manifest version is '1.1.0' and the released version is '1.0.0'
315+
> The manifest version is '1.1.0' and the released version is '1.0.0'
301316
> 🚀 Will release! The manifest version is greater than the released version.
302317
303-
> The manifest version is '1.0.0' and the released version is '1.0.0'
318+
> The manifest version is '1.0.0' and the released version is '1.0.0'
304319
> 😴 Holding back from release: The manifest version is not greater than the released version.
305320
306321
> ⚠️ Version 0.0.0 is reserved and will never be released.
@@ -323,7 +338,7 @@ the steps below:
323338
324339
### Removing a single release
325340
326-
Open a pull request to remove the release:
341+
Open a pull request to remove the release:
327342
328343
1. Remove the release from the content list in `extension.json`
329344
- If the removed release is the latest release, update the `latestVersion`
@@ -332,7 +347,7 @@ Open a pull request to remove the release:
332347
the first element in the `versions` array
333348
2. Revert the content's `version` in the `manifest.json` file to the previous
334349
release
335-
350+
336351
Once the pull request is merged continue with the steps below:
337352
338353
1. Remove the associated release from the [GitHub Releases page](https://github.com/posit-dev/connect-extensions/releases).
@@ -356,7 +371,7 @@ And after the pull request is merged:
356371
## Removing Content
357372
358373
Removing content from the `extensions/` subdirectory that has already been
359-
added to the Connect Gallery requires that you follow instructions in the
374+
added to the Connect Gallery requires that you follow instructions in the
360375
above [Removing an entire piece of content](#removing-an-entire-piece-of-content)
361376
section.
362377

0 commit comments

Comments
 (0)