Sending to Remotes

GitHub Destinations

Prerequisites:

• Git repository connected to GitHub
• GitHub PAT with repo scope (run projr_instr_auth_github() for setup)
• Token stored in _environment.local (git-ignored): GITHUB_PAT=ghp_...

# Add a GitHub release for raw data
projr_yml_dest_add_github(
  title = "raw-data-@version",
  content = "raw-data"
)

# Add a GitHub release for outputs
projr_yml_dest_add_github(
  title = "output-@version",
  content = "output"
)

YAML equivalent:

build:
  github:
    raw-data-release:
      title: "raw-data-@version"
      content: [raw-data]
    output-release:
      title: "output-@version"
      content: [output]

Parameters:

• title – release name. Use @version for automatic versioning (e.g. "raw-data-v0.1.0"). Spaces become hyphens. Must be unique per repository.
• content – directory label to archive (raw-data, cache, output, docs, code).

Note: GitHub has a 2 GB limit per release asset. For larger datasets, use local remotes or split across multiple releases.

Local Destinations

No authentication required. Parent directories must exist before the first build. Use absolute paths for clarity; relative paths resolve from the project root.

# Archive to local directory
projr_yml_dest_add_local(
  title = "local-backup",
  content = "output",
  path = "~/project-archive/output"
)

# Archive to network drive
projr_yml_dest_add_local(
  title = "network-backup",
  content = "raw-data",
  path = "/mnt/shared/projects/my-project/data"
)

YAML equivalent:

build:
  local:
    local-backup:
      title: "local-backup"
      content: [output]
      path: "~/project-archive/output"

Parameters:

• title – descriptive name (identification only).
• content – directory label to archive.
• path – destination directory (absolute or project-relative).

Customization Options

Both GitHub and local remotes accept the same optional parameters. Defaults are shown first.

Complete Configuration Examples

# Raw data: archive, only when changed
projr_yml_dest_add_github(
  title = "raw-data-@version",
  content = "raw-data",
  structure = "archive",
  send_cue = "if-change",
  send_strategy = "sync-diff",
  send_inspect = "manifest"
)

# Output: archive every version
projr_yml_dest_add_github(
  title = "output-@version",
  content = "output",
  structure = "archive",
  send_cue = "always",
  send_strategy = "sync-diff",
  send_inspect = "manifest"
)

# Docs: overwrite with latest
projr_yml_dest_add_github(
  title = "docs-latest",
  content = "docs",
  structure = "latest",
  send_cue = "always",
  send_strategy = "sync-purge",
  send_inspect = "none"
)

# Raw data to local archive
projr_yml_dest_add_local(
  title = "raw-data-archive",
  content = "raw-data",
  path = "~/research-archive/my-project/raw-data",
  structure = "archive",
  send_cue = "if-change",
  send_strategy = "sync-diff",
  send_inspect = "manifest"
)

# Output to network drive
projr_yml_dest_add_local(
  title = "output-network",
  content = "output",
  path = "/mnt/shared/project/output",
  structure = "latest",
  send_cue = "always",
  send_strategy = "sync-purge",
  send_inspect = "none"
)

# GitHub for public sharing
projr_yml_dest_add_github(
  title = "output-@version",
  content = "output",
  structure = "archive"
)

# Local for quick backup
projr_yml_dest_add_local(
  title = "output-local",
  content = "output",
  path = "~/backup/output",
  structure = "archive"
)

# Network for team access
projr_yml_dest_add_local(
  title = "output-network",
  content = "output",
  path = "/mnt/shared/output",
  structure = "latest"
)

Build Workflow

Remotes activate automatically during production builds:

projr_build_dev()   # does NOT upload to remotes
projr_build_patch() # uploads (0.1.0 -> 0.1.1)
projr_build_minor() # uploads (0.1.0 -> 0.2.0)
projr_build_major() # uploads (0.1.0 -> 1.0.0)

Build steps with remotes configured:

1. Clear output directories, run pre-build hooks, hash input files
2. Bump version
3. Render documents and scripts
4. Hash output files, update manifest
5. Git commit (if configured)
6. Upload to remotes
7. Run post-build hooks

Check and validate your configuration:

projr_yml_get()$build$github
projr_yml_get()$build$local
projr_yml_check()

If remotes aren’t uploading, verify you are running a production build (not projr_build_dev()), send_cue is not "never", and authentication is configured for GitHub destinations.

Best Practices

• Use @version in GitHub release titles; use descriptive prefixes like "raw-data-@version".
• Archive raw-data separately from output.
• Start with the defaults: structure = "archive", send_strategy = "sync-diff", send_cue = "if-change", send_inspect = "manifest".
• Use send_cue = "if-change" for large, rarely-changing datasets.
• For local remotes, prefer absolute paths (~/archive/, /mnt/shared/).
• Store tokens in _environment.local only – never commit secrets.
• Test configuration with projr_build_dev() first (no uploads).
• For slow uploads, switch to "sync-diff" + "manifest" inspection.

Quick Reference

# Minimal GitHub remote
projr_yml_dest_add_github(
  title = "output-@version",
  content = "output"
)

# Minimal local remote
projr_yml_dest_add_local(
  title = "output-backup",
  content = "output",
  path = "~/archive/output"
)

# Run production build
projr_build_patch()

Recommended defaults:

See Also

• ?projr_yml_dest_add_github – GitHub remote documentation
• ?projr_yml_dest_add_local – Local remote documentation
• vignette("dest-send-workflow") – Internal workflow for sending to destinations (with diagrams)
• vignette("restore-artifacts") – Restoring archived artifacts
• vignette("environment") – Environment variables including GITHUB_PAT