Skip to contents

Create a dockerignore template for OS-related files

Source: R/dockerignore-templates.R
dk_template_ignore_os.Rd

Creates a dockerignore template with patterns to ignore operating system specific files and directories.

Usage

dk_template_ignore_os(.dockerignore = NULL)

Arguments

.dockerignore

Optional existing dockerignore object to add patterns to

Value

A dockerignore object with OS-related ignore patterns

Details

This template adds patterns to ignore operating system specific files that aren't needed in a Docker image, including:

  • .DS_Store: macOS folder metadata

  • Thumbs.db: Windows thumbnail cache

  • desktop.ini: Windows folder configuration

  • *.swp, *~: Temporary editor files

  • .directory: KDE folder metadata

  • Icon?: macOS icon files

  • *.lnk: Windows shortcuts

These files are typically not needed in a Docker image and can reduce the build context size.

See also

dk_template_ignore_editor() for editor-specific patterns & dk_template_ignore_common() for a more comprehensive template

Other dockerignore template functions: dk_template_ignore_common(), dk_template_ignore_data(), dk_template_ignore_editor(), dk_template_ignore_git(), dk_template_ignore_node(), dk_template_ignore_packrat(), dk_template_ignore_python(), dk_template_ignore_r(), dk_template_ignore_raw_data(), dk_template_ignore_renv()

Examples

# Create a new dockerignore with OS patterns
di <- dk_template_ignore_os()
di
#> .DS_Store
#> Thumbs.db
#> desktop.ini
#> *.swp
#> *~
#> .directory
#> Icon?
#> ehthumbs.db
#> *.lnk 

# Add OS patterns to an existing dockerignore
di <- dockerignore() |>
  di_add("*.log") |>
  dk_template_ignore_os()
di
#> *.log
#> .DS_Store
#> Thumbs.db
#> desktop.ini
#> *.swp
#> *~
#> .directory
#> Icon?
#> ehthumbs.db
#> *.lnk