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

Added .pack-ignore documentation #332

Merged
merged 5 commits into from Oct 12, 2020
Merged

Added .pack-ignore documentation #332

merged 5 commits into from Oct 12, 2020

Conversation

DeanArbel
Copy link
Contributor

@DeanArbel DeanArbel commented Oct 12, 2020

Status

Ready

Description

Added .pack-ignore documentation

Docs addition:

.pack-ignore

This file allows ignoring linter errors while lint checking and ignoring tests in the test collection.

To add ignored tests/linter errors in a file, first, add the file name to the .pack-ignore in this format

[file:integration-to-ignore.yml]

On the following line add ignore= flag, with one or more comma-separated values:

  1. auto-test - ignore test file in the build test collection.
  2. linter code e.g. IN126 - ignore linter error codes.

Example .pack-ignore

[file:playbook-Special-Test-Not-To-Run-Directly.yml]
ignore=auto-test

[file:integration-to-ignore.yml]
ignore=IN126,PA116

@DeanArbel DeanArbel marked this pull request as ready for review October 12, 2020 08:05
@DeanArbel DeanArbel requested a review from glicht October 12, 2020 08:05
@xsoar-bot
Copy link

Preview Site Available

Congratulations! The automatic build has completed succesfully.
A preview site is available at: https://packignoredocs--demisto-content-docs.netlify.app


Important: Make sure to inspect your changes at the preview site.

@fvigo
Copy link
Contributor

fvigo commented Oct 12, 2020

@anara123 @glicht @ShahafBenYakir do we want this information to be publicly available to external contributors?

@ShahafBenYakir
Copy link
Contributor

ShahafBenYakir commented Oct 12, 2020

@fvigo It's ok IMO this file is also reviewed so if there is something the user ignored by mistake we can always ask to remove it.

@DeanArbel DeanArbel merged commit 3b66af6 into master Oct 12, 2020
@DeanArbel DeanArbel deleted the PackIgnoreDocs branch October 12, 2020 14:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants