PublishPipelineArtifact .artifact ignore not recognized

Question

I am using Azure DevOps build pipeline to send a artifact over to a release pipeline. My build pipeline is as follows:

Install Node JS with NodeTool@0
Run a Script Command that runs npm install and then runs the test suite.
Post the code coverage results via PublishCodeCoverageResults@1
Publish artifact with PublishPipelineArtifact@1 and targetPath: '$(Pipeline.Workspace)' as the artifact directory.

When I originally did this without using the code coverage part, IE not installing node, the files sent over were 257 and was a little over 25MB. Completely workable and quick.

However when I installed node and ran code coverage the files exploded to 750MB, which is understandable - but is way too much to transfer as an artifact IMHO.

So, looking at a solution I found this: https://learn.microsoft.com/en-us/azure/devops/artifacts/reference/artifactignore?view=azure-devops

And, I added this into the root of the repo.

Example

However, this file seems to have not made a difference using the PublishPipelineArtifact@1 at all. No matter what I did, all the files from the Workspace were used as the artifact.

What did work though, was physically deleting the files in the build process.

I realize that is a lot of detail for a question, but I would like to know if the .artifactignore file actually works with this build pipeline?

Is there a way I can use the artifact ignore file properly, and not worry about deleting files before creating the artifact?

Tried to change the target directory in the PublishPipelineArtifact@1 task.

Here is the current working YAML:

# Node.js with Angular
# Build a Node.js project that uses Angular.
# Add steps that analyze code, save build artifacts, deploy, and more:
# https://learn.microsoft.com/azure/devops/pipelines/languages/javascript

trigger:
- master

pool:
  vmImage: 'ubuntu-latest'

steps:
- task: NodeTool@0
  inputs:
    versionSpec: '10.x'
  displayName: 'Install Node.js'

- script: |
    npm install
    npm run test:devops
  displayName: 'npm install and test'

- task: PublishCodeCoverageResults@1
  displayName: 'publish ng code coverage results'
  condition: succeededOrFailed()
  inputs:
    codeCoverageTool: 'Cobertura'
    summaryFileLocation: 'coverage/cobertura-coverage.xml'
    reportDirectory: coverage
    failIfCoverageEmpty: true

- task: DeleteFiles@1
  inputs:
    SourceFolder: '$(Pipeline.Workspace)/s'
    Contents: |
      node_modules
      coverage

- task: PublishPipelineArtifact@1
  inputs:
    targetPath: '$(Pipeline.Workspace)'
    artifact: 'my-artifact'

The expected results would be a smaller artifact file that still posts code coverage and installs node.

Ok, I used the information below, but wanted to put a working yaml together. ``` — kirikintha, Jul 18 '19 at 23:22

score 7 · Accepted Answer · answered Jul 16 '19 at 06:30

7

The .artifactignore should be in the same directory as defined as target path of the publish pipelines artifact task (not only in the root of the repo like azure-pipelines.yml).

Is not in the docs and there is an issue about it here. also check here.

answered Jul 16 '19 at 06:30

Shayki Abramczyk

36,824
16
89
114

Hi there - I understand in general what you are referring to, however I am not sure how to reconcile this with my build. Do I need to copy the artifact file to a location as well? Thank you. – kirikintha Jul 18 '19 at 16:25
Before you copy the artifacts you need to verify that the .artifactignore exist there. – Shayki Abramczyk Jul 18 '19 at 16:34
1

if you would like to ignore only files in a specified folder, use `/*` at the end, e.g.: `**/.terraform/*`, when you would like to ignore files and subfolders (everything) in a specified folder, then use `/**` at the end, e.g.: `**/.terraform/**` – Łukasz Kurzyniec Mar 31 '22 at 13:53

kirikintha · Answer 2 · 2019-09-22T16:30:30.477

Ok, so I used the information from Shayki Abramczyk - which is the correct answer - but wanted to put a working yaml together for everyone. I had to copy my .artifactignore from the repo, which is: $(Pipeline.Workspace)/s to the root which is $(Pipeline.Workspace)

As soon as I did this - it showed results. As soon as I adjusted the artifact ignore file, the output reduced from 750+MB to 2.3MB and processed in 8 seconds.

Working YAML:

- task: NodeTool@0
  inputs:
    versionSpec: '10.x'
  displayName: 'Install Node.js'

- script: |
    npm install
    npm run test
  displayName: 'npm install and test'

- task: PublishCodeCoverageResults@1
  displayName: 'publish ng code coverage results'
  condition: succeededOrFailed()
  inputs:
    codeCoverageTool: 'Cobertura'
    summaryFileLocation: 'coverage/cobertura-coverage.xml'
    reportDirectory: coverage
    failIfCoverageEmpty: true

- task: CopyFiles@2
  inputs:
    SourceFolder: '$(Pipeline.Workspace)/s'
    Contents: '**/.artifactignore'
    TargetFolder: '$(Pipeline.Workspace)'

- task: PublishPipelineArtifact@1
  inputs:
    targetPath: '$(Pipeline.Workspace)'
    artifact: 'my-artifact'

FYI - this is being built for angular, so this is the artifact ignore file I used. Your mileage will vary based on your project.

**/dist
**/node_modules
**/coverage
**/.git

The copy files task should contain the flatten folders token, which is set to true. `- task: CopyFiles@2 displayName: 'Copy .artifactignore' inputs: SourceFolder: '$(build.sourcesdirectory)' Contents: '**/.artifactignore' TargetFolder: '$(build.artifactstagingdirectory)' flattenFolders: true` — Peter, May 13 '20 at 12:42
It is also worth to mention that the above solution won't work if `- task: PublishBuildArtifacts@1` is used to publish the articfact. — Alex Raj Kaliamoorthy, Mar 26 '21 at 20:41
I don't get the whole concept. If I'm forced to use ```CopyFiles@2``` than i can exclude files using the that task. In that case i don't need ".artifactignore". Is there any way to use ".artifactignore" without additional task as CopyFiles ? — IvanAK, Jan 11 '22 at 14:59

PublishPipelineArtifact .artifact ignore not recognized

2 Answers2