GitHub Docs Read

This Snap has one document input view.

Incoming documents are enriched with file content and metadata. Records with change_type: removed pass through without modification.

• Mapper
• GitHub File List

This Snap has one document output view.

Each output document retains all incoming fields and appends: sha, size, content (raw body text), and title (first # heading in the file, falling back to the filename in Path mode or an empty string in SHA mode). In Path mode, path, url, author, and last_modified are also appended.

• Mapper

Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: GitHub Docs Read

Enter the repository containing the file, in owner/repository_name format. When chaining from GitHub File List, set this field to $repository with the expression toggle enabled.

Default value: None

Example: SnapLogic/my-repo

Enter the path of the file to fetch, relative to the repository root. Fetching by path returns commit author and timestamp metadata. When a value is entered, the SHA field is hidden.

This field is mutually exclusive with SHA. Enter either Path or SHA, not both.

Default value: None

Example: docs/index.md

Enter the blob SHA of the file to fetch. Fetching by SHA is faster than fetching by path but does not return commit author or timestamp metadata. When chaining from GitHub File List, set this field to $sha with the expression toggle enabled. When a value is entered, the Path and Ref fields are hidden.

This field is mutually exclusive with Path. Enter either SHA or Path, not both.

Default value: None

Example: $sha

Appears when Path is in use.

Enter a branch name, tag, or commit SHA to fetch the file at a specific point in history. Leave blank to fetch from the repository's default branch.

Default value: None

Example: feature/my-branch

Snap execution

Default value: Validate & execute