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

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

Open
1 task done
jsoref opened this issue Nov 12, 2024 · 3 comments
Open
1 task done

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

jsoref opened this issue Nov 12, 2024 · 3 comments
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 needs SME This proposal needs review from a subject matter expert waiting for review Issue/PR is waiting for a writer's review

Comments

@jsoref
Copy link
Contributor

jsoref commented Nov 12, 2024

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 jsoref added the content This issue or pull request belongs to the Docs Content team label Nov 12, 2024
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 12, 2024
@jsoref
Copy link
Contributor Author

jsoref commented Nov 12, 2024

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 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 Nov 12, 2024
@nguyenalex836
Copy link
Contributor

@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! 💛

@subatoi subatoi added the needs SME This proposal needs review from a subject matter expert label Nov 13, 2024
Copy link
Contributor

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

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 needs SME This proposal needs review from a subject matter expert waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

No branches or pull requests

3 participants