Skip to content

Conversation

@ferdnyc
Copy link
Contributor

@ferdnyc ferdnyc commented Oct 2, 2023

Why: The Workflow Commands documentation had some minor formatting issues

  • A few examples didn't fit the code block width and were wrapped, impacting readability, only because they used overlong and misleading names.
  • Another example switched between ALL_CAPS and lower_case for the same variable name, which goes against the docs' own advice (added recently in ee2816b) that variables should be treated case-sensitively for safety.
  • I also discovered some weird control characters in the indentation of one example.

Each of these issues is addressed as a separate commit in the PR.

Closes: --

What's being changed (if available, include any code snippets, screenshots, or gifs):

A few of the example code-blocks in the "Workflow commands for GitHub Actions" document, to correct the issues listed above.

Four blocks similar to...

Old:

      - name: Set color
        id: random-color-generator
        run: echo "SELECTED_COLOR=green" >> "$GITHUB_OUTPUT"
      - name: Get color
        env:
          SELECTED_COLOR: ${{ steps.random-color-generator.outputs.SELECTED_COLOR }}
        run: echo "The selected color is $SELECTED_COLOR"

New:

      - name: Set color
        id: color-selector
        run: echo "SELECTED_COLOR=green" >> "$GITHUB_OUTPUT"
      - name: Get color
        env:
          SELECTED_COLOR: ${{ steps.color-selector.outputs.SELECTED_COLOR }}
        run: echo "The selected color is $SELECTED_COLOR"

...Because the shorter strings avoid wrapping, and also because "echo green" is a pretty terrible implementation for a so-called "random color generator".

One block with mixed variable case...

Old:

jobs:
  secret-generator:
    runs-on: ubuntu-latest
    steps:
    - uses: some/secret-store@v1
      with:
        credentials: ${{ secrets.SECRET_STORE_CREDENTIALS }}
        instance: ${{ secrets.SECRET_STORE_INSTANCE }}
    - name: generate secret
      shell: bash
      run: |
        GENERATED_SECRET=$((RANDOM))
        echo "::add-mask::$GENERATED_SECRET"
        SECRET_HANDLE=$(secret-store store-secret "$GENERATED_SECRET")
        echo "handle=$secret_handle" >> "$GITHUB_OUTPUT"

New:

jobs:
  secret-generator:
    runs-on: ubuntu-latest
    steps:
    - uses: some/secret-store@v1
      with:
        credentials: ${{ secrets.SECRET_STORE_CREDENTIALS }}
        instance: ${{ secrets.SECRET_STORE_INSTANCE }}
    - name: generate secret
      shell: bash
      run: |
        GENERATED_SECRET=$((RANDOM))
        echo "::add-mask::$GENERATED_SECRET"
        SECRET_HANDLE=$(secret-store store-secret "$GENERATED_SECRET")
        echo "handle=$SECRET_HANDLE" >> "$GITHUB_OUTPUT"

Because the docs advise against doing exactly what the code was doing: mixing variable case.

Two code lines indented with control characters (non-breaking spaces?)

Diff view with visible whitespace and control-character display;

image

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline.

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

Some of the code is needlessly wrapping, only because it
uses over-long strings. (Also, the "random-color-generator"
only returns "green", which isn't very random.)
Recent commit ee2816b added a note to the docs advising that
it's safest to always treat variable names as case-sensitive.
Good advice, so let's lead by example.
A couple of the example lines were indented with some strange
invisible control characters; replace with ordinary spaces.
@welcome
Copy link

welcome bot commented Oct 2, 2023

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Oct 2, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Oct 2, 2023

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/using-workflows/workflow-commands-for-github-actions.md fpt
ghec
ghes@ 3.10 3.9 3.8 3.7 3.6
ghae
fpt
ghec
ghes@ 3.10 3.9 3.8 3.7 3.6
ghae

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server
ghae: GitHub AE

@ferdnyc
Copy link
Contributor Author

ferdnyc commented Oct 2, 2023

Oh, well... turns out the ghae version wraps either way. Can't win 'em all.

@cmwilson21
Copy link
Contributor

@ferdnyc Thanks so much for submitting a PR! We really appreciate all the details and the examples you provided! This will make it easier to review 🎉

I'll get this triaged for review ⚡

@cmwilson21 cmwilson21 added content This issue or pull request belongs to the Docs Content team 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 Oct 3, 2023
Copy link
Contributor

@skedwards88 skedwards88 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this PR! We'll get this merged for you.

@skedwards88 skedwards88 added this pull request to the merge queue Oct 3, 2023
@skedwards88 skedwards88 added hacktoberfest-accepted We might not merge this PR before Nov 1st, but it's a wonderful Hacktoberfest contribution! ready to merge This pull request is ready to merge labels Oct 3, 2023
Merged via the queue into github:main with commit fa371f4 Oct 3, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Oct 3, 2023

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

@ferdnyc ferdnyc deleted the patch-1 branch October 4, 2023 00:12
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 hacktoberfest-accepted We might not merge this PR before Nov 1st, but it's a wonderful Hacktoberfest contribution! ready to merge This pull request is ready to merge waiting for review Issue/PR is waiting for a writer's review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants