Docker pre.entrypoint links to Node pre.pre-if

[jsoref]

Code of Conduct

• I have read and agree to the GitHub Docs project's Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/actions/sharing-automations/creating-actions/metadata-syntax-for-github-actions#runspre-entrypoint

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

I think a distinct .pre-if should be added to the https://docs.github.com/en/actions/sharing-automations/creating-actions/metadata-syntax-for-github-actions#runs-for-docker-container-actions and https://docs.github.com/en/actions/sharing-automations/creating-actions/metadata-syntax-for-github-actions#runspre-entrypoint's runs.pre-if link should be changed to point to it.

Additional information

Here's a run with pre-if: true:

  pre-entrypoint: '/pre.sh'
  pre-if: true

pre

Here's a run with pre-if: false (which is good because the pre-entrypoint was broken):

  pre-entrypoint: 'pre.sh'
  pre-if: false

https://github.com/check-spelling-sandbox/bookish-rotary-phone/actions/runs/11798769996/job/32865715637

[jsoref]

I'm not sure how easy it would be to split the two pre-if statements two get distinct anchors. Offhand, I'd strongly recommend splitting the document into:

1. page for actions in general that links to individual pages for javascript, composite, and docker
2. reusable shared-action-definitions head basically everything from https://docs.github.com/en/actions/sharing-automations/creating-actions/metadata-syntax-for-github-actions#about-yaml-syntax-for-github-actions stopping before runs
3. page for JavaScript actions with includes for reusable shared-action-definitions head and reusable shared-action-definitions tail
4. page for composite actions with includes for reusable shared-action-definitions head and reusable shared-action-definitions tail
5. page for Docker container actions with includes for reusable shared-action-definitions head and reusable shared-action-definitions tail
6. reusable shared-action-definitions tail with branding

The number of people who want to look at the syntax for more than one kind of action at a time can be counted on one hand and they all more or less work on either actions/runner or nektos/act. Everyone else only cares about one kind of action (on average javascript or composite) and doesn't need to be confused by the other two.

[nguyenalex836]

@jsoref Thank you for raising this issue! I'll get this triaged for review ✨ Our team will provide feedback regarding the best next steps for this issue - thanks for your patience! 💛

[github-actions]

Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert 👀

[nguyenalex836]

@jsoref Thanks for your patience while our SME team reviewed! ✨ They agreed on almost suggestions, but wanted to relay the following -

The only thing is that I don't think that a new section like this should just link to the run.pre-if section for Javascript, because of the disparity between pre vs pre-entrypoint.

We wanted to get your thoughts on this before opening this up for contributions, just so we're all on the same page 💛

[jsoref]

I'm happy with totally different content sections or reusable content blocks. I can't remember precisely what I was thinking here and the GitHub Mobile app UI is not helping me figure it out.

As long as it's possible to easily understand the two at least somewhat unrelated items, I'd be happy.

(I don't expect to be able to look back/into anything until late December or early January.)

[nguyenalex836]

I'm happy with totally different content sections or reusable content blocks. I can't remember precisely what I was thinking here and the GitHub Mobile app UI is not helping me figure it out.

As long as it's possible to easily understand the two at least somewhat unrelated items, I'd be happy.

@jsoref Awesome! We're aligned on this ✨

(I don't expect to be able to look back/into anything until late December or early January.)

No problem - we are happy to let this issue rest until you are ready to submit a PR if this sounds good to you 💛

[jsoref]

Feel free to update the guidance and I'll try to circle back when I can.

[jsoref]

I should note that I don't think I was really sure how to make two sections with the same name.

I think somewhere I had a note / idea that the action documentation should be split into distinct files based on the category. There's too little value in showing a composite author information about docker action or JavaScript.

Where the content is the same, using reusables seems like a better strategy than sharing the same user facing web page.