Skip to content

Commit 084c971

Browse files
authored
Merge branch 'main' into repo-sync
2 parents 3ba45a8 + 5989091 commit 084c971

File tree

442 files changed

+8092
-1172
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

442 files changed

+8092
-1172
lines changed

content/actions/using-workflows/reusing-workflows.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ You can define inputs and secrets, which can be passed from the caller workflow
110110
runs-on: ubuntu-latest
111111
environment: production
112112
steps:
113-
- uses: ./.github/actions/my-action@v1
113+
- uses: ./.github/actions/my-action
114114
with:
115115
username: ${{ inputs.username }}
116116
token: ${{ secrets.envPAT }}
@@ -151,7 +151,7 @@ jobs:
151151
name: Pass input and secrets to my-action
152152
runs-on: ubuntu-latest
153153
steps:
154-
- uses: ./.github/actions/my-action@v1
154+
- uses: ./.github/actions/my-action
155155
with:
156156
username: ${{ inputs.username }}
157157
token: ${{ secrets.token }}

content/actions/using-workflows/workflow-syntax-for-github-actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ jobs:
149149
150150
steps:
151151
- name: Pass the received secret to an action
152-
uses: ./.github/actions/my-action@v1
152+
uses: ./.github/actions/my-action
153153
with:
154154
token: ${{ secrets.access-token }}
155155
```

content/repositories/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Repositories
3-
intro: Learn to use and manage the repositories that allow you to store and collaborate on your project's code.
3+
intro: "Learn to use and manage the repositories that allow you to store and collaborate on your project's code."
44
introLinks:
55
quickstart: /get-started/quickstart/create-a-repo
66
overview: /repositories/creating-and-managing-repositories/about-repositories

lib/rest/static/decorated/api.github.com.json

Lines changed: 34 additions & 10 deletions
Large diffs are not rendered by default.

lib/rest/static/decorated/ghes-3.0.json

Lines changed: 8 additions & 8 deletions
Large diffs are not rendered by default.

lib/rest/static/decorated/ghes-3.1.json

Lines changed: 8 additions & 8 deletions
Large diffs are not rendered by default.

lib/rest/static/decorated/ghes-3.2.json

Lines changed: 8 additions & 8 deletions
Large diffs are not rendered by default.

lib/rest/static/decorated/ghes-3.3.json

Lines changed: 8 additions & 8 deletions
Large diffs are not rendered by default.

lib/rest/static/decorated/github.ae.json

Lines changed: 8 additions & 8 deletions
Large diffs are not rendered by default.

lib/rest/static/dereferenced/api.github.com.deref.json

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -223065,7 +223065,7 @@
223065223065
},
223066223066
"post": {
223067223067
"summary": "Create a deployment",
223068-
"description": "Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.\n\nBy default, [commit statuses](https://docs.github.com/rest/reference/repos#statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nUsers with `repo` or `repo_deployment` scopes can create a deployment for a given ref.\n\n#### Merged branch response\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\n#### Merge conflict response\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\n#### Failed commit status checks\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.",
223068+
"description": "Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.\n\nBy default, [commit statuses](https://docs.github.com/rest/reference/commits#commit-statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nUsers with `repo` or `repo_deployment` scopes can create a deployment for a given ref.\n\n#### Merged branch response\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\n#### Merge conflict response\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\n#### Failed commit status checks\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.",
223069223069
"tags": [
223070223070
"repos"
223071223071
],
@@ -223115,7 +223115,7 @@
223115223115
},
223116223116
"required_contexts": {
223117223117
"type": "array",
223118-
"description": "The [status](https://docs.github.com/rest/reference/repos#statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.",
223118+
"description": "The [status](https://docs.github.com/rest/reference/commits#commit-statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.",
223119223119
"items": {
223120223120
"type": "string"
223121223121
}
@@ -224409,7 +224409,7 @@
224409224409
},
224410224410
"delete": {
224411224411
"summary": "Delete a deployment",
224412-
"description": "To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status).\"",
224412+
"description": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status).\"",
224413224413
"tags": [
224414224414
"repos"
224415224415
],
@@ -408573,7 +408573,7 @@
408573408573
},
408574408574
"patch": {
408575408575
"summary": "Update a codespace for the authenticated user",
408576-
"description": "Updates a codespace owned by the authenticated user. Currently only the codespace's machine type can be modified using this endpoint.\n\nOnce you specify a new machine type it will be applied the next time your codespace is started.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.",
408576+
"description": "Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint.\n\nIf you specify a new machine type it will be applied the next time your codespace is started.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.",
408577408577
"tags": [
408578408578
"codespaces"
408579408579
],
@@ -408603,6 +408603,13 @@
408603408603
"machine": {
408604408604
"description": "A valid machine to transition this codespace to.",
408605408605
"type": "string"
408606+
},
408607+
"recent_folders": {
408608+
"description": "Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in.",
408609+
"type": "array",
408610+
"items": {
408611+
"type": "string"
408612+
}
408606408613
}
408607408614
}
408608408615
},

0 commit comments

Comments
 (0)