Skip to content

Clarify build context file inclusion #1159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
radiantjade wants to merge 1 commit into from
Closed

Clarify build context file inclusion #1159

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions content/docs/builds/build-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,22 @@ commands will operate within the defined root directory.

**Note:** The **Railway Config File** does not follow the **Root Directory** path. You have to specify the absolute path for the `railway.json` or `railway.toml` file, for example: `/backend/railway.toml`

## Build context and included files

For GitHub deployments, Railway builds from the files available in the
selected repository and Root Directory. A tracked file is included in the build
context even if it matches a `.gitignore` pattern, because `.gitignore` only
prevents untracked files from being added to Git.

For CLI deployments with `railway up`, the CLI creates and uploads an archive
from your local files. By default, this archive respects `.gitignore`; use
`railway up --no-gitignore` when you need to include ignored local files.

To exclude files from a Railpack or Dockerfile build context, add a
`.dockerignore` file at the relevant source root. This is useful for keeping
local dependencies, build artifacts, and large generated assets out of the
image.

## Configure watch paths

Watch paths are <a href="https://git-scm.com/docs/gitignore#_pattern_format" target="_blank">gitignore-style</a> patterns
Expand Down
8 changes: 7 additions & 1 deletion content/docs/cli/deploying.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,12 +196,18 @@ When running `railway up` from a subdirectory without a path argument, Railway s

## Ignoring files

By default, Railway respects your `.gitignore` file. To include ignored files in your deployment:
By default, `railway up` respects your `.gitignore` file when it creates the
local upload archive. To include ignored files in your deployment:

```bash
railway up --no-gitignore
```

This behavior applies to CLI uploads. GitHub deployments build from the files
that are present in the selected repository and Root Directory; files already
tracked by Git are still available to the build even if they match a
`.gitignore` pattern.

## Verbose output

For debugging deployment issues:
Expand Down
Loading