Skip to content

fix: Update first example to not use expression syntax #17868

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

fix: Update first example to not use expression syntax #17868

wants to merge 1 commit into from

Conversation

schalkneethling
Copy link

This changes the first example not to use expression syntax to match the copy in the previous paragraph.

When you use expressions in an if conditional, you may omit the expression syntax (${{ }}) because GitHub automatically evaluates the if conditional as an expression.

Why:

Closes #17867

What's being changed:

From:

steps:
  - uses: actions/hello-world-javascript-action@v1.1
    if: ${{ <expression> }}

to:

steps:
  - uses: actions/hello-world-javascript-action@v1.1
    if: <expression>

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.

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

fix: Update first example to not use expression syntax
c5d6790 
This changes the first example not to use expression syntax to match the copy in the previous paragraph.

> When you use expressions in an if conditional, you may omit the expression syntax (${{ }}) because GitHub automatically evaluates the if conditional as an expression.
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label May 15, 2022
@github-actions
Copy link
Contributor

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.

Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
actions/learn-github-actions/expressions.md fpt
ghec
ghes@ 3.5 3.4 3.3 3.2 3.1
ghae
 fpt
ghec
ghes@ 3.5 3.4 3.3 3.2 3.1
ghae

@steveward steveward added waiting for review Issue/PR is waiting for a writer's review content This issue or pull request belongs to the Docs Content team and removed triage Do not begin working on this issue until triaged by the team labels May 16, 2022
@steveward
Copy link
Member

Thanks for the PR @schalkneethling! I'll get this triaged for review.

@lucascosti
Copy link
Contributor

👋 @schalkneethling thanks for this PR! Yes, the text states that it isn't compulsory to include the brackets, but most of our examples in our docs do include them, so at the moment the first example on that page should match the syntax shown elsewhere and have the brackets.

@lucascosti lucascosti closed this May 30, 2022
@lucascosti lucascosti mentioned this pull request May 30, 2022
Closed
1 task
@schalkneethling schalkneethling deleted the patch-3 branch May 30, 2022 10:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
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
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Possible confusion might be created in expression syntax docs
3 participants
@schalkneethling @steveward @lucascosti