https://github.com/coatless-rpkg/multideploy
Systematically deploy files across multiple GitHub repositories
https://github.com/coatless-rpkg/multideploy
Last synced: 22 days ago
JSON representation
Systematically deploy files across multiple GitHub repositories
- Host: GitHub
- URL: https://github.com/coatless-rpkg/multideploy
- Owner: coatless-rpkg
- License: agpl-3.0
- Created: 2024-09-03T04:39:07.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-04-01T03:21:14.000Z (2 months ago)
- Last Synced: 2025-04-01T03:33:30.571Z (2 months ago)
- Language: R
- Homepage: http://r-pkg.thecoatlessprofessor.com/multideploy/
- Size: 1.08 MB
- Stars: 11
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# multideploy 
[](https://github.com/coatless-rpkg/multideploy/actions/workflows/R-CMD-check.yaml)
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
The `{multideploy}` package provides tools for deploying file changes
across multiple GitHub repositories. It’s designed to help you manage
standardized configurations, CI/CD workflows, and other common files
that need to be synchronized across multiple repositories.
## Installation
You can install the development version of `{multideploy}` from
[GitHub](https://github.com/coatless-rpkg/multideploy) with:
``` r
# install.packages("remotes")
remotes::install_github("coatless-rpkg/multideploy")
```
## Authentication
`{multideploy}` uses the [`gh`](https://github.com/r-lib/gh) package for
GitHub API authentication and querying. Before using `{multideploy}`,
make sure you have a GitHub Personal Access Token (PAT) set up:
``` r
# Set GitHub PAT (or use .Renviron)
Sys.setenv(GITHUB_PAT = askpass::askpass("What is your GitHub Personal Access Token (PAT)?"))
```
For regular use, it’s recommended to add your PAT to the git credential
system through the [`{gitcreds}`](https://github.com/r-lib/gitcreds)
package:
``` r
gitcreds::gitcreds_set()
```
## Quick Start Example
Here’s an example showing how to deploy a standardized CI workflow file
to multiple repositories using `{multideploy}`:
``` r
library(multideploy)
# List repositories in an organization matching a pattern
repos <- repos("my-organization", filter_regex = "^api-")
# Deploy a CI workflow file to the selected repositories
results <- file_deploy(
source_file = "templates/check-standard.yml",
target_path = ".github/workflows/R-CMD-check.yaml",
repos = repos
)
# View results
print(results)
```
> \[!IMPORTANT\]
>
> The GitHub PAT used for authentication must have the necessary
> permissions to access and modify the repositories’ workflows.
## Extended Overview
If you’re looking for more detailed examples on how to use
`{multideploy}`, we step through the additional features of the package
within this section.
### Repository Selection
List and filter repositories across users or organizations:
``` r
# Get all public repositories for a user
user_repos <- repos("username", type = "public")
# Get repositories for an organization matching a pattern
org_repos <- repos("orgname", filter_regex = "^data-")
# List organizations you have access to
my_orgs <- orgs()
```
### File Deployment
Deploy individual files or sets of files to multiple repositories:
``` r
# Deploy a single file
file_deploy("local/path/file.R", "remote/path/file.R", repos)
# Create a mapping of multiple files
mapping <- file_mapping(
"local/lint.R" = ".lintr",
"local/gitignore" = ".gitignore",
dir = "templates/workflows",
pattern = "\\.ya?ml$",
target_prefix = ".github/workflows/"
)
# Create pull requests with multiple file changes
pr_create(
repos = repos,
branch_name = "feature/standardize-workflows",
title = "Standardize CI workflows",
body = "Implements organization-wide CI workflow standards",
file_mapping = mapping
)
```
### Dry Run Mode
Preview changes before making them:
``` r
# Preview changes without making them
file_deploy("local/file.R", "remote/file.R", repos, dry_run = TRUE)
# Preview PR creation
pr_create(repos, "branch-name", "PR Title", "PR Body", mapping, dry_run = TRUE)
```
## License
AGPL (\>= 3)