diff --git a/docs/spec/v1alpha1/gitrepositories.md b/docs/spec/v1alpha1/gitrepositories.md index 3db341ce..208c3b2c 100644 --- a/docs/spec/v1alpha1/gitrepositories.md +++ b/docs/spec/v1alpha1/gitrepositories.md @@ -1,8 +1,8 @@ # Git Repositories The `GitRepository` API defines a source for artifacts coming from Git. The -resource exposes the latest synchronized state from Git as an artifact in -an archive. +resource exposes the latest synchronized state from Git as an artifact in a +[gzip compressed TAR archive](#artifact). ## Specification @@ -112,6 +112,24 @@ const ( ) ``` +## Artifact + +The `GitRepository` API defines a source for artifacts coming from Git. The +resource exposes the latest synchronized state from Git as an artifact in a +gzip compressed TAR archive (`.tar.gz`). + +### Excluding files + +Git files (`.git/`, `.gitignore`, `.gitmodules`, and `.gitattributes`) are +excluded from the archive by default, as well as some extensions (`.jpg, .jpeg, +.gif, .png, .wmv, .flv, .tar.gz, .zip`) + +Excluding additional files from the archive is possible by adding a +`.sourceignore` file in the root of the repository. The `.sourceignore` file +follows [the `.gitignore` pattern +format](https://git-scm.com/docs/gitignore#_pattern_format), pattern +entries may overrule default exclusions. + ## Spec examples Pull the master branch of a public repository every minute: