Skip to content

Commit

Permalink
Prep for release
Browse files Browse the repository at this point in the history
  • Loading branch information
nealrichardson committed Apr 5, 2024
1 parent fbcfbb1 commit f2d4e2d
Show file tree
Hide file tree
Showing 6 changed files with 43 additions and 43 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/issue_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Bug report or feature request
about: Describe a bug you've seen or make a case for a new feature
---

Please briefly describe your problem and what output you expect. If you have a question, please don't use this form. Instead, ask on <https://stackoverflow.com/> or <https://community.rstudio.com/>.
Please briefly describe your problem and what output you expect. If you have a question, please don't use this form. Instead, ask on <https://stackoverflow.com/> or <https://forum.posit.co/>.

Please include a minimal reproducible example (AKA a reprex). If you've never heard of a [reprex](http://reprex.tidyverse.org/) before, start by reading <https://www.tidyverse.org/help/#reprex>.

Expand Down
30 changes: 15 additions & 15 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,31 +5,31 @@ Before filing an issue, there are a few places to explore and pieces to put toge

## Make a reprex

Start by making a minimal **repr**oducible **ex**ample using the [reprex](https://reprex.tidyverse.org/) package.
If you haven't heard of or used reprex before, you're in for a treat!
Seriously, reprex will make all of your R-question-asking endeavors easier (which is a pretty insane ROI for the five to ten minutes it'll take you to learn what it's all about).
Start by making a minimal **repr**oducible **ex**ample using the [reprex](https://reprex.tidyverse.org/) package.
If you haven't heard of or used reprex before, you're in for a treat!
Seriously, reprex will make all of your R-question-asking endeavors easier (which is a pretty insane ROI for the five to ten minutes it'll take you to learn what it's all about).
For additional reprex pointers, check out the [Get help!](https://www.tidyverse.org/help/) section of the tidyverse site.

## Where to ask?

Armed with your reprex, the next step is to figure out [where to ask](https://www.tidyverse.org/help/#where-to-ask).
Armed with your reprex, the next step is to figure out [where to ask](https://www.tidyverse.org/help/#where-to-ask).

* If it's a question: start with [community.rstudio.com](https://community.rstudio.com/), and/or StackOverflow. There are more people there to answer questions.
* If it's a question: start with [forum.posit.co](https://forum.posit.co/), and/or StackOverflow. There are more people there to answer questions.

* If it's a bug: you're in the right place, [file an issue](https://github.com/rstudio/connectapi/issues/new).

* If you're not sure: let the community help you figure it out!
If your problem _is_ a bug or a feature request, you can easily return here and report it.
* If it's a bug: you're in the right place, [file an issue](https://github.com/rstudio/connectapi/issues/new).

Before opening a new issue, be sure to [search issues and pull requests](https://github.com/rstudio/connectapi/issues) to make sure the bug hasn't been reported and/or already fixed in the development version.
By default, the search will be pre-populated with `is:issue is:open`.
You can [edit the qualifiers](https://help.github.com/articles/searching-issues-and-pull-requests/) (e.g. `is:pr`, `is:closed`) as needed.
* If you're not sure: let the community help you figure it out!
If your problem _is_ a bug or a feature request, you can easily return here and report it.

Before opening a new issue, be sure to [search issues and pull requests](https://github.com/rstudio/connectapi/issues) to make sure the bug hasn't been reported and/or already fixed in the development version.
By default, the search will be pre-populated with `is:issue is:open`.
You can [edit the qualifiers](https://help.github.com/articles/searching-issues-and-pull-requests/) (e.g. `is:pr`, `is:closed`) as needed.
For example, you'd simply remove `is:open` to search _all_ issues in the repo, open or closed.

## What happens next?

To be as efficient as possible, development of tidyverse packages tends to be very bursty, so you shouldn't worry if you don't get an immediate response.
Typically we don't look at a repo until a sufficient quantity of issues accumulates, then there’s a burst of intense activity as we focus our efforts.
That makes development more efficient because it avoids expensive context switching between problems, at the cost of taking longer to get back to you.
This process makes a good reprex particularly important because it might be multiple months between your initial report and when we start working on it.
Typically we don't look at a repo until a sufficient quantity of issues accumulates, then there’s a burst of intense activity as we focus our efforts.
That makes development more efficient because it avoids expensive context switching between problems, at the cost of taking longer to get back to you.
This process makes a good reprex particularly important because it might be multiple months between your initial report and when we start working on it.
If we can’t reproduce the bug, we can’t fix it!
12 changes: 6 additions & 6 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Type: Package
Package: connectapi
Title: Utilities for Interacting with the 'Posit Connect' Server API
Version: 0.1.3.9000
Authors@R:
Version: 0.1.4
Authors@R:
c(person(given = "Sean",
family = "Lopp",
role = c("aut")),
Expand All @@ -12,15 +12,15 @@ Authors@R:
email = "cole@posit.co"),
person(given = "Posit, PBC",
role = c("cph", "fnd")))
Description: Provides a helpful 'R6' class and methods for interacting with
Description: Provides a helpful 'R6' class and methods for interacting with
the 'Posit Connect' Server API along with some meaningful utility functions
for regular tasks. API documentation varies by 'Posit Connect' installation
and version, but the latest documentation is also hosted publicly at
and version, but the latest documentation is also hosted publicly at
<https://docs.posit.co/connect/api/>.
License: MIT + file LICENSE
URL: https://pkgs.rstudio.com/connectapi/, https://github.com/rstudio/connectapi
BugReports: https://github.com/rstudio/connectapi/issues
Imports:
Imports:
config,
dplyr,
fs,
Expand All @@ -38,7 +38,7 @@ Imports:
yaml,
bit64,
jsonlite
Suggests:
Suggests:
crayon,
dbplyr,
flexdashboard,
Expand Down
10 changes: 5 additions & 5 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# connectapi (development version)
# connectapi 0.1.4

- Now correctly provides methods for `tbl_connect`, rather than `tbl_lazy`,
preventing problems when also using dplyr (#177).
- BREAKING: The functions `Connect$download_bundle()` and
`Connect$bundle_delete()` have been removed. Use `Content$bundle_download()`
and `Content$bundle_delete()` instead.
- `Content$tag_delete()` removes the tag from the target content item rather
than removing the tag entirely. (#194)
- Correctly provides methods for `tbl_connect` rather than `tbl_lazy`,
preventing problems when also using dbplyr (#177).

# connectapi 0.1.3.1

Expand Down Expand Up @@ -125,7 +125,7 @@

# connectapi 0.1.0.9017

BREAKING:
BREAKING:
* Switch from `RSTUDIO_CONNECT_*` variables to `CONNECT_*` variables
* Rename a handful of functions:
- `connect$activate_bundle` to `connect$content_deploy`
Expand All @@ -143,7 +143,7 @@ BREAKING:
- `cache_apps`
- `tag_page`

OTHER:
OTHER:
* Add some endpoints:
- `content`
- `audit_logs`
Expand Down
16 changes: 8 additions & 8 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Please pay careful attention to the lifecycle badges of the various functions
and warnings present when you are using experimental features.

**Also, [please share
feedback!!](https://community.rstudio.com/c/r-admin/posit-connect/27) We love
feedback!!](https://forum.posit.co/c/r-admin/posit-connect/27) We love
hearing how the Posit Connect Server API is helpful and what additional
endpoints would be useful!!**

Expand Down Expand Up @@ -124,16 +124,16 @@ client <- connect()
# NOTE: a `manifest.json` should already exist from `rsconnect::writeManifest()`
bundle <- bundle_dir("./path/to/directory")
content <- client %>%
deploy(bundle, name = "my-app-name") %>%
content <- client %>%
deploy(bundle, name = "my-app-name") %>%
poll_task()
# set an image for content
content %>%
content %>%
set_image_path("./my/local/image.png")
content %>%
content %>%
set_image_url("http://url.example.com/image.png")
# set image and a vanity URL
Expand All @@ -145,13 +145,13 @@ content %>%
# change access_type to "anyone"
content$update(access_type = "all")
# edit another piece of content
client %>%
content_item("the-content-guid") %>%
set_vanity_url("/another-awesome-app")
# migrate content to another server
client_prod <- connect(
Expand Down Expand Up @@ -217,7 +217,7 @@ If you get this error message, our recommendation would be:

Please feel free to open an Issue if you think there is a bug, or ask a
free-form question on [Posit
Community](https://community.rstudio.com/c/r-admin/posit-connect/27)
Community](https://forum.posit.co/c/r-admin/posit-connect/27)

**Other ideas for FAQs or Common Issues?**

Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Please pay careful attention to the lifecycle badges of the various
functions and warnings present when you are using experimental features.

**Also, [please share
feedback!!](https://community.rstudio.com/c/r-admin/posit-connect/27) We
feedback!!](https://forum.posit.co/c/r-admin/posit-connect/27) We
love hearing how the Posit Connect Server API is helpful and what
additional endpoints would be useful!!**

Expand Down Expand Up @@ -120,16 +120,16 @@ client <- connect()
# NOTE: a `manifest.json` should already exist from `rsconnect::writeManifest()`

bundle <- bundle_dir("./path/to/directory")
content <- client %>%
deploy(bundle, name = "my-app-name") %>%
content <- client %>%
deploy(bundle, name = "my-app-name") %>%
poll_task()

# set an image for content

content %>%
content %>%
set_image_path("./my/local/image.png")

content %>%
content %>%
set_image_url("http://url.example.com/image.png")

# set image and a vanity URL
Expand All @@ -141,13 +141,13 @@ content %>%
# change access_type to "anyone"

content$update(access_type = "all")

# edit another piece of content

client %>%
content_item("the-content-guid") %>%
set_vanity_url("/another-awesome-app")

# migrate content to another server

client_prod <- connect(
Expand Down Expand Up @@ -220,7 +220,7 @@ If you get this error message, our recommendation would be:

Please feel free to open an Issue if you think there is a bug, or ask a
free-form question on [Posit
Community](https://community.rstudio.com/c/r-admin/posit-connect/27)
Community](https://forum.posit.co/c/r-admin/posit-connect/27)

**Other ideas for FAQs or Common Issues?**

Expand Down

0 comments on commit f2d4e2d

Please sign in to comment.