Fix environment.url example#40276
Conversation
|
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. |
There was a problem hiding this comment.
Pull Request Overview
This PR fixes an invalid YAML syntax example in the GitHub Actions documentation for environment configuration. The url property was incorrectly shown as a job-level property when it should be nested under the environment object.
- Corrected the environment configuration syntax to properly nest
nameandurlunder theenvironmentkey - Updated the YAML structure to follow the correct GitHub Actions workflow syntax
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
|
@sliekens Looks good! Thanks for updating the example. |
|
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 ⚡ |
Why:
The 'url' example is invalid:
urlcannot be specified as a property of the job, only as a property of itsenvironment.Related docs: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idenvironment
What's being changed (if available, include any code snippets, screenshots, or gifs):
jobs: JOB-ID: - environment: ENVIRONMENT-NAME - url: URL + environment: + name: ENVIRONMENT-NAME + url: URLCheck off the following: