docs icon indicating copy to clipboard operation
docs copied to clipboard

Mismatch between explanation and code about triggers used

Open carlos-quintero opened this issue 1 year ago • 1 comments
trafficstars

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 avatar Jun 30 '24 13:06 carlos-quintero

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

nguyenalex836 avatar Jul 01 '24 18:07 nguyenalex836

@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 avatar Jul 02 '24 10:07 hubwriter

I've now reviewed the PR that will close this issue: https://github.com/github/docs/pull/33783

hubwriter avatar Jul 02 '24 10:07 hubwriter