fluxcd
/
source-controller
mirror of https://github.com/fluxcd/source-controller.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Spec: document Git artifact file exclusion

This commit is contained in:
Hidde Beydals 2020-06-05 20:08:13 +02:00
parent 39ee34897a
commit 43ea51b435
1 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/spec/v1alpha1/gitrepositories.md
View File

@ -1,8 +1,8 @@
# Git Repositories # Git Repositories
The `GitRepository` API defines a source for artifacts coming from Git. The The `GitRepository` API defines a source for artifacts coming from Git. The
resource exposes the latest synchronized state from Git as an artifact in resource exposes the latest synchronized state from Git as an artifact in a
an archive. [gzip compressed TAR archive](#artifact).
## Specification ## 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 (`<commit hash>.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 ## Spec examples
Pull the master branch of a public repository every minute: Pull the master branch of a public repository every minute: