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

Mismatch between explanation and code about triggers used #33777

Closed
1 task done
carlos-quintero opened this issue Jun 30, 2024 · 3 comments · Fixed by #33783
Closed
1 task done

Mismatch between explanation and code about triggers used #33777

carlos-quintero opened this issue Jun 30, 2024 · 3 comments · Fixed by #33783
Labels
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 help wanted Anyone is welcome to open a pull request to fix this issue

Comments

@carlos-quintero
Copy link

Code of Conduct

What article on docs.github.com is affected?

Publishing Docker images (https://docs.github.com/en/actions/publishing-packages/publishing-docker-images)

What part(s) of the article would you like to see updated?

  1. In the section "Publishing images to Docker Hub" it says:

The workflow in the example below runs when the release event triggers with the created activity type.

while the code uses the published activity type:

on:
  release:
    types: [published]
  1. In the section Publishing images to GitHub Packages is says:

The workflow in the example below runs when the release event triggers with the created activity type.

while the code uses a push trigger:

on:
  push:
    branches: ['release']

Additional information

No response

@carlos-quintero carlos-quintero added the content This issue or pull request belongs to the Docs Content team label Jun 30, 2024
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jun 30, 2024
@nguyenalex836 nguyenalex836 added actions This issue or pull request should be reviewed by the docs actions team waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Jul 1, 2024
@nguyenalex836
Copy link
Contributor

@carlos-quintero Thank you for opening an issue! I'll get this triaged for review ✨

@hubwriter hubwriter added help wanted Anyone is welcome to open a pull request to fix this issue and removed waiting for review Issue/PR is waiting for a writer's review labels Jul 2, 2024
@hubwriter
Copy link
Contributor

@carlos-quintero - Thank you for raising this. It would be good to correct the workflow triggers in the https://docs.github.com/en/actions/publishing-packages/publishing-docker-images article, as per the details you've given above.

I've marked this issue help-wanted. If you (or anyone else reading this) would like to raise a pull request to update the docs accordingly that would be great.

Information about contributing to the docs:
https://docs.github.com/en/contributing

@hubwriter
Copy link
Contributor

I've now reviewed the PR that will close this issue:
#33783

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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 help wanted Anyone is welcome to open a pull request to fix this issue
3 participants