Federalist is becoming cloud.gov logo icon cloud.gov Pages! Checkout more about the transition here. 🎉

Skip to main content
U.S. flag

An official website of the United States government

Dot gov

The .gov means it’s official.
Federal government websites often end in .gov or .mil. Before sharing sensitive information, make sure you’re on a federal government site.

Https

The site is secure.
The https:// ensures that you are connecting to the official website and that any information you provide is encrypted and transmitted securely.

Exclude and Include Paths

You can configure custom exclude and include paths for your site with the excludePaths and includePaths keys in the Federalist configuration file.

Syntax

The excludePaths and includePaths keys in Federalist configuration file should include a list of unix-style glob patterns to match against the paths of individual files to be deployed for your site.

Example

{
  "excludePaths": [
    "/some-exact/file.yml",
    "*/all-files-with-this-name.txt"
  ],
  "includePaths": [
    "/.some-dot-file"
  ]
}

Path Pattern Matching Rules

Tip

Many libraries already provide a mechanism to exclude files from the results of the build, which should be preferred since it can be tested locally.

Tip

For engines with a build step, the files to be included must not be excluded by your build process. For example, Jekyll excludes dotfiles by default, so you would have to also configure Jekyll to include the desired files.

Note

These are different matching rules than apply for custom headers.

Examples

Pattern Description
*/file.txt matches all (nested or not) files named file.txt
/file.txt matches exactly /file.txt
/folder* matches exactly folders with names starting with /folder and their contents
/folder/* matches the contents of /folder
/folder matches exactly /folder but not it’s contents

See unix-style glob for all possibilities.

Defaults

Excluded files

Included files

As configuration

{
  "excludeFiles": [
    "*/Dockerfile",
    "*/docker-compose.yml",
    "/federalist.json",
    "/pages.json"
  ],
  "includeFiles": [
    "/.well-known/security.txt"
  ]
}