Skip to content

Github Actions Release Trigger | docs wrongly state that release-Action is triggered on draft #15839

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

Merged
merged 2 commits into from
Apr 4, 2022

Conversation

kohlerdominik
Copy link
Contributor

Why:

My tests lead me to the assumption, that the released-action is only triggered when a release is done (either directly or by finishing a draft).

The docs say, release is also triggered when a release-draft is published. But IMO this isn't the case. And it wouldn't make sense with an action called release, as a draft is NOT a release.

What's being changed:

The docs state, that a Webhook with the action=released is triggered, when a draft is published.

released: a release or draft of a release is published, or a pre-release is changed to a release

But IMO this is neither the case, nor would it make sense regarding the naming. A draft is NOT a release.

Check off the following:

  • I have reviewed my changes in staging (look for "Automatically generated comment" and click Modified to view your latest changes).
  • For content changes, I have completed the self-review checklist.

My tests lead me to the assumption, that the `released`-action is only triggered when a release is done (either directly or by finishing a draft).

The docs say, `release` is also triggered when a release-draft is published. But IMO this isn't the case. And it wouldn't make sense with an action called `release`, as a draft is NOT a release.
@welcome
Copy link

welcome bot commented Feb 25, 2022

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Feb 25, 2022
@ramyaparimi ramyaparimi added actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review webhooks Content related to webhooks and removed triage Do not begin working on this issue until triaged by the team actions This issue or pull request should be reviewed by the docs actions team labels Feb 25, 2022
@ramyaparimi
Copy link
Contributor

@kohlerdominik
Thanks so much for opening a PR! I'll get this triaged for review ⚡

@Danielferencz21

This comment was marked as spam.

Copy link

@davidmerwin davidmerwin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

@davidmerwin

This comment was marked as spam.

Copy link
Contributor

@lucascosti lucascosti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this fix, @kohlerdominik.

@lucascosti lucascosti enabled auto-merge April 4, 2022 05:54
@lucascosti lucascosti merged commit fa18117 into github:main Apr 4, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Apr 4, 2022

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review webhooks Content related to webhooks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants