posit-dev / posit-dev/connectapi
Update from git but don't trigger run?
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 54
- Forks
- 27
- Avg merge
- 1d 3m
- Merged PRs (30d)
- 1
Description
👋 thanks again for this awesome package.
I currently have a scenario where I have a run of a git-backed rmd being triggered externally via {connectapi}. This basically happens on a nightly basis. I'd love to have the ability to before doing that run, if i could trigger a check to make sure the rmd on connect is up to date with the latest commit and if not update the connect rmd with the latest changes. deploy_repo_update does this but it also triggers a run. Would you be open to a PR that a) add documentation that clarifies that deploy_repo_update does this and b) adds an argument that defaults to the current behaviour but can be changes to just update and re-run?
Here is sort of a reprex:
library(connectapi)
library(curl)
library(glue)
client <- connect(
server = secrets,
api_key = secrets
)
report <- content_item(client, rmd_id)
## trigger update from git repo if needed
deploy_repo_update(report)
## get the id for the default variant
rmd_content_variant <- get_variant_default(report)
## render the rmd
rendering <- variant_render(rmd_content_variant)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the deploy_repo_update entry point and compare its current behavior with the requested update-only path in the reprex. Review how the function is documented and how it triggers a run, then verify that the default behavior remains unchanged and that the new option updates from Git without triggering a run.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, r
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100