Skip to content

Conversation

sliekens
Copy link
Contributor

@sliekens sliekens commented Sep 7, 2025

Why:

The 'url' example is invalid: url cannot be specified as a property of the job, only as a property of its environment.

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

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the review environment.

@Copilot Copilot AI review requested due to automatic review settings September 7, 2025 09:47
Copy link

welcome bot commented Sep 7, 2025

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.

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

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 name and url under the environment key
  • Updated the YAML structure to follow the correct GitHub Actions workflow syntax

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

github-actions bot commented Sep 7, 2025

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 links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
actions/how-tos/write-workflows/choose-what-workflows-do/deploy-to-environment.md fpt
ghec
ghes@ 3.17 3.16 3.15 3.14
fpt
ghec
ghes@ 3.17 3.16 3.15 3.14

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

🤖 This comment is automatically generated.

@Sharra-writes Sharra-writes added content This issue or pull request belongs to the Docs Content team github_actions Pull requests that update GitHub Actions code and removed triage Do not begin working on this issue until triaged by the team labels Sep 8, 2025
@Sharra-writes
Copy link
Contributor

@sliekens Looks good! Thanks for updating the example.

@Sharra-writes Sharra-writes added this pull request to the merge queue Sep 8, 2025
Merged via the queue into github:main with commit 3832b84 Sep 8, 2025
41 checks passed
Copy link
Contributor

github-actions bot commented Sep 8, 2025

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team github_actions Pull requests that update GitHub Actions code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants