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

Rename ShouldSkip, for clarity of what this flag is meant to mean (should mean ~ Ignore This Event) #9

Open
viktorbenei opened this issue Jun 7, 2016 · 1 comment

Comments

@viktorbenei
Copy link
Contributor

viktorbenei commented Jun 7, 2016

Related line:

Should be renamed & add more comment.

This flag is meant to be used when the whole event should be discarded/skipped, with a success response. Examples:

  • GitHub sends a "ping" event when you add a new webhook, which can't be used and should not be used to trigger a build, it just have to be "acknowledged". Same is true for visualstudio.com / VSTS
  • Another case is that every service sends tag push events as "code commit" event. If you enable code push events for the webhook you'll get tag pushes too. Tag pushes are not handled by Bitrise.io right now, but returning an error every time would not be appropriate either, so we just acknowledge and skip it
    • Note: bitrise.io does support Tag triggers since

So the point is, ShouldSkip is too generic, the variable should be renamed to ShouldIgnoreEvent or similar for better clarity.

@viktorbenei
Copy link
Contributor Author

Should also be noted that this will skip/ignore the whole event. E.g Bitbucket and VSTS can send commits in batches - if this flag is set then no build will be started, even if one commit could be used for triggering a build. This is a "full event" skip flag!

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

1 participant