docs icon indicating copy to clipboard operation
docs copied to clipboard

Fix job services localhost example in workflow-syntax-for-github-actions.md

Open piotrekkr opened this issue 1 year ago â€ĸ 6 comments

Why:

Because job services localhost example is wrong and misleading.

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

Current example states that :

When you specify the Docker host port but not the container port, the container port is randomly assigned to a free port. GitHub sets the assigned container port in the ${{job.services.<service_name>.ports}} context. In this example, you can access the service container ports using the ${{ job.services.nginx.ports['8080'] }} and ${{ job.services.redis.ports['6379'] }} contexts.

Which is not true because you either specify container port only and then GitHub Actions will choose random free port on host, or you specify both, host and container port.

To access host port you should use container port as a key. In nginx example it should be ${{ job.services.nginx.ports['80'] }} and not 8080.

Updated job services yaml example to show more clearly how to access those services.

I tested all this using this yaml

jobs:
  job-a:
    runs-on: ubuntu-latest
    services:
      nginx:
        image: nginx
        # Map port 8080 on the Docker host to port 80 on the nginx container
        ports:
          - 8080:80
      redis:
        image: redis
        # Map TCP port 6379 on Docker host to a random free port on the Redis container
        ports:
          - 6379/tcp
    steps:
      - run: docker ps
      - run: echo '${{ toJSON(job.services) }}'
      - run: |
          echo "Redis available on 127.0.0.1:${{ job.services.redis.ports['6379'] }}"
          echo "Nginx available on 127.0.0.1:${{ job.services.nginx.ports['80'] }}"
      - name: Check Redis
        run: |
          echo -e '*1\r\n$4\r\nPING\r\n' | netcat -w1 127.0.0.1 ${{ job.services.redis.ports['6379'] }}

image

Check off the following:

  • [x] I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • 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.
  • [x] For content changes, I have completed the self-review checklist.

piotrekkr avatar Jun 21 '24 07:06 piotrekkr

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.

welcome[bot] avatar Jun 21 '24 07:06 welcome[bot]

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/writing-workflows/workflow-syntax-for-github-actions.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10

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

github-actions[bot] avatar Jun 21 '24 07:06 github-actions[bot]

@piotrekkr Thanks so much for opening a PR! I'll get this triaged for review ✨

nguyenalex836 avatar Jun 21 '24 17:06 nguyenalex836

Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert :eyes:

github-actions[bot] avatar Jul 25 '24 21:07 github-actions[bot]

This is a gentle bump for the docs team that this PR is waiting for technical review.

github-actions[bot] avatar Aug 23 '24 16:08 github-actions[bot]

5545554

Raj564321 avatar Aug 28 '24 16:08 Raj564321

A stale label has been added to this pull request because it has been open 7 days with no activity. To keep this PR open, add a comment or push a commit within 3 days.

github-actions[bot] avatar Sep 12 '24 16:09 github-actions[bot]

A stale label has been added to this pull request because it has been open 7 days with no activity. To keep this PR open, add a comment or push a commit within 3 days.

github-actions[bot] avatar Sep 20 '24 16:09 github-actions[bot]

A stale label has been added to this pull request because it has been open 7 days with no activity. To keep this PR open, add a comment or push a commit within 3 days.

github-actions[bot] avatar Sep 30 '24 16:09 github-actions[bot]

A stale label has been added to this pull request because it has been open 7 days with no activity. To keep this PR open, add a comment or push a commit within 3 days.

github-actions[bot] avatar Oct 08 '24 16:10 github-actions[bot]

@piotrekkr Thank you so much for your patience while our SME team reviewed! 💛 They have approved of your changes after testing your example ✨

Once you are able to resolve the conflicts with this branch, we are happy to get this merged! If submitting a new PR is easier for you, we're happy to merge that instead 🙇

nguyenalex836 avatar Oct 09 '24 21:10 nguyenalex836

@nguyenalex836 I've rebased my branch on latest code. There is no conflicts any more.

piotrekkr avatar Oct 10 '24 07:10 piotrekkr

@piotrekkr Thank you! 💛 Getting this merged now!

nguyenalex836 avatar Oct 10 '24 16:10 nguyenalex836

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 :zap:

github-actions[bot] avatar Oct 10 '24 16:10 github-actions[bot]