Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: create trigger-based task with multi-step declaration yaml file #176

Closed
ellieayla opened this issue Jan 15, 2019 · 4 comments

Comments

@ellieayla
Copy link

Is this a BUG REPORT or FEATURE REQUEST?:

Documentation bug (for a 1.0-preview-1 feature, so I suspect it just hasn't been done yet).

What happened?:

I wrote a multi-step declaration yaml file ala https://docs.microsoft.com/en-us/azure/container-registry/container-registry-tasks-multi-step, and am able to run it fine with az acr run -r myregistry -f multi-step-task.yaml .

But I want to run that build triggered by git commits.

That doc says "Tasks support both manual execution, called a "quick run," and automated execution on Git commit or base image update." and "For more information about automated builds on Git commit or base image update, see the Automate image builds and Base image update builds tutorial articles.".

Both of those documents describe creating a durable task object with az acr task create, passing the URL of a git repository & a Dockerfile. Neither state that az task task create can accept one of these multi-step yaml files with --file.

As far as I can tell, the only place (other than this issue) this is mentioned is inside the az acr task create help text; these two sentences.

$ az acr task create -h | head

Command
    az acr task create : Creates a series of steps for building, testing and OS & Framework patching
    containers. Tasks support triggers from git commits and base image updates.

Arguments
    --context -c        [Required] : The full URL to the source code repository (Requires '.git'
                                     suffix for a github repo).
    --file -f           [Required] : The relative path of the the task/docker file to the source
                                     code root folder. Task files must be suffixed with '.yaml'.

I didn't find that option until after I started writing this issue, which was originally please add such a feature.

What did you expect to happen?:

Expected to find documentation on this feature in a mobile webbrowser in bed. Instead I needed a working python & the az cli.

How do you reproduce it (as minimally and precisely as possible)?:

Try to find public documentation outside the az cli that says az acr task create --file accepts a multi-step yaml definition.

Anything else we need to know?:

Environment (if applicable to the issue):

  • Azure CLI/Powershell/SDK version
    • azure-cli (2.0.54)
    • acr (2.1.11)
@northtyphoon
Copy link
Member

Thanks for the suggestion. We will review the document and make appropriate changes.

@sajayantony
Copy link
Contributor

/cc @dlepow

@sajayantony
Copy link
Contributor

@dlepow - The basic update here is to the documentation page to state that --file can be either a docker file or a multi-step task YAML file now that the feature is generally available.

https://docs.microsoft.com/en-us/azure/container-registry/container-registry-tutorial-build-task#create-the-build-task

@sajayantony sajayantony self-assigned this May 16, 2019
@dlepow
Copy link
Contributor

dlepow commented May 31, 2019

@sajayantony - We recently published a second tutorial to expand on the scenario with a multi-step task YAML file: https://docs.microsoft.com/en-us/azure/container-registry/container-registry-tutorial-multistep-task#create-a-multi-step-task
So I think we can now close this issue. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants