Working with image tags

    You can define your tag in the stack YAML file. By default this tag is “:latest”

    or

    1. image: my-fn:latest

    Option 2 - --tag option

    The --tag option works with the faas-cli sub-commands: build, push and deploy.

    When using a —tag feature which relies on metadata from a Git commit then the build, push and deploy commands must be run pointing at the same Git commit.

    Example usage:

    1. faas-cli build --tag=sha|branch|describe
    2. faas-cli push --tag=sha|branch|describe
    3. faas-cli deploy --tag=sha|branch|describe

    There are currently three formats for “automatic tags”.

    Example:

    2. image: my-other-fn

    Gives the equivalent:

    In this example you will get an output which includes the SHA and the branch name. This is useful for promotion code through enviroments with a continuous delivery tool. If you use one branch per environment in Git then the tool can parse the tag and match it to an environment.

    Example:

    (on the master branch)

    1. image: my-fn:0.2
    3. image: my-fn:latest

    Gives the equivalent:

    1. image: my-fn:0.2-master-cf59cfc
    3. image: my-fn:latest-master-cf59cfc
    1. image: my-fn:0.2-staging-cf59cfc
    2. image: my-fn:latest-staging-cf59cfc

    In this example you will get the output of git describe --tags --always. This returns a human readable name based on an available git ref. Using , means that the output which can be read as <most-recent-parent-tag>-<number-of-commits-to-that-tag>-g<short-sha>. Using --always, means that if the repo does not use tags, then we will still get the short SHA as output, matching --tag=sha

    Example:

    If you set the image name as

    Then, if you have no tags in the repo, faas-cli produces the equivalent:

    1. image: my-fn:0.2-b0da13a
    3. image: my-fn:latest-cfb0da13a59cfc

    If you have just tagged the current commit in the repo, then faas-cli produces the equivalent:

    1. image: my-fn:0.2-v0.1.0
    3. image: my-fn:latest-v0.1.0

    Note that the middle value, <number-of-commits-to-that-tag> is omitted when it is 0, that is, when you build that tag.

    1. image: my-fn:0.2-v0.1.0-1-gb0da13a

    A word of caution, this can only reference the tags that your local repository knows of, make sure to run git fetch --tags to ensure that you have a copy of all remote tags.