Skip to content

Commit

Permalink
Merge branch 'main' into evi-liu-patch-1
Browse files Browse the repository at this point in the history
  • Loading branch information
sophietheking authored Jun 13, 2022
2 parents 630d1d2 + 46c701b commit e8fa298
Show file tree
Hide file tree
Showing 212 changed files with 1,194 additions and 821 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/check-all-english-links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ jobs:
# The default is 10s. But because this runs overnight, we can
# be a lot more patient.
REQUEST_TIMEOUT: 20000
# Don't care about CDN caching image URLs
DISABLE_REWRITE_ASSET_URLS: true
# The default is 300 which works OK on a fast macbook pro
# but so well in Actions.
LINKINATOR_CONCURRENCY: 100
Expand Down
6 changes: 6 additions & 0 deletions .github/workflows/link-check-all.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@ jobs:
run: cat $HOME/files.json

- name: Link check (warnings, changed files)
env:
# Don't care about CDN caching image URLs
DISABLE_REWRITE_ASSET_URLS: true
run: |
./script/rendered-content-link-checker.mjs \
--language en \
Expand All @@ -59,6 +62,9 @@ jobs:
--list $HOME/files.json
- name: Link check (critical, all files)
env:
# Don't care about CDN caching image URLs
DISABLE_REWRITE_ASSET_URLS: true
run: |
./script/rendered-content-link-checker.mjs \
--language en \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ redirect_from:
- /actions/deployment/security-hardening-your-deployments/using-oidc-with-your-reusable-workflows
versions:
fpt: '*'
ghae: issue-4757-and-5856
ghae: issue-4757
ghec: '*'
ghes: '>=3.5'
type: how_to
Expand Down
8 changes: 4 additions & 4 deletions content/actions/learn-github-actions/contexts.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ You can access contexts using the expression syntax. For more information, see "
| `matrix` | `object` | Contains the matrix properties defined in the workflow that apply to the current job. For more information, see [`matrix` context](#matrix-context). |
| `needs` | `object` | Contains the outputs of all jobs that are defined as a dependency of the current job. For more information, see [`needs` context](#needs-context). |
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-4757 %}
| `inputs` | `object` | Contains the inputs of a reusable {% if actions-unified-inputs %}or manually triggered {% endif %}workflow. For more information, see [`inputs` context](#inputs-context). |{% endif %}
| `inputs` | `object` | Contains the inputs of a reusable {% ifversion actions-unified-inputs %}or manually triggered {% endif %}workflow. For more information, see [`inputs` context](#inputs-context). |{% endif %}

As part of an expression, you can access context information using one of two syntaxes.

Expand Down Expand Up @@ -714,15 +714,15 @@ jobs:
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-4757 %}
## `inputs` context

The `inputs` context contains input properties passed to a reusable workflow{% if actions-unified-inputs %} or to a manually triggered workflow{% endif %}. {% if actions-unified-inputs %}For reusable workflows, the{% else %}The{% endif %} input names and types are defined in the [`workflow_call` event configuration](/actions/learn-github-actions/events-that-trigger-workflows#workflow-reuse-events) of a reusable workflow, and the input values are passed from [`jobs.<job_id>.with`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idwith) in an external workflow that calls the reusable workflow. {% if actions-unified-inputs %}For manually triggered workflows, the inputs are defined in the [`workflow_dispatch` event configuration](/actions/learn-github-actions/events-that-trigger-workflows#workflow_dispatch) of a workflow.{% endif %}
The `inputs` context contains input properties passed to a reusable workflow{% ifversion actions-unified-inputs %} or to a manually triggered workflow{% endif %}. {% ifversion actions-unified-inputs %}For reusable workflows, the{% else %}The{% endif %} input names and types are defined in the [`workflow_call` event configuration](/actions/learn-github-actions/events-that-trigger-workflows#workflow-reuse-events) of a reusable workflow, and the input values are passed from [`jobs.<job_id>.with`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idwith) in an external workflow that calls the reusable workflow. {% ifversion actions-unified-inputs %}For manually triggered workflows, the inputs are defined in the [`workflow_dispatch` event configuration](/actions/learn-github-actions/events-that-trigger-workflows#workflow_dispatch) of a workflow.{% endif %}

There are no standard properties in the `inputs` context, only those which are defined in the workflow file.

{% data reusables.actions.reusable-workflows-ghes-beta %}

| Property name | Type | Description |
|---------------|------|-------------|
| `inputs` | `object` | This context is only available in a [reusable workflow](/actions/learn-github-actions/reusing-workflows){% if actions-unified-inputs %} or in a workflow triggered by the [`workflow_dispatch` event](/actions/learn-github-actions/events-that-trigger-workflows#workflow_dispatch){% endif %}. You can access this context from any job or step in a workflow. This object contains the properties listed below. |
| `inputs` | `object` | This context is only available in a [reusable workflow](/actions/learn-github-actions/reusing-workflows){% ifversion actions-unified-inputs %} or in a workflow triggered by the [`workflow_dispatch` event](/actions/learn-github-actions/events-that-trigger-workflows#workflow_dispatch){% endif %}. You can access this context from any job or step in a workflow. This object contains the properties listed below. |
| `inputs.<name>` | `string` or `number` or `boolean` | Each input value passed from an external workflow. |

### Example contents of the `inputs` context
Expand Down Expand Up @@ -767,7 +767,7 @@ jobs:
```
{% endraw %}

{% if actions-unified-inputs %}
{% ifversion actions-unified-inputs %}
### Example usage of the `inputs` context in a manually triggered workflow

This example workflow triggered by a `workflow_dispatch` event uses the `inputs` context to get the values of the `build_id`, `deploy_target`, and `perform_deploy` inputs that were passed to the workflow.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ shortTitle: Remove workflow artifacts

{% warning %}

**Warning:** Once you delete an artifact, it can not be restored.
**Warning:** Once you delete an artifact, it cannot be restored.

{% endwarning %}

Expand Down
16 changes: 8 additions & 8 deletions content/actions/using-workflows/events-that-trigger-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -1250,12 +1250,12 @@ on: workflow_dispatch

#### Providing inputs

You can configure custom-defined input properties, default input values, and required inputs for the event directly in your workflow. When you trigger the event, you can provide the `ref` and any `inputs`. When the workflow runs, you can access the input values in the {% if actions-unified-inputs %}`inputs`{% else %}`github.event.inputs`{% endif %} context. For more information, see "[Contexts](/actions/learn-github-actions/contexts)."
You can configure custom-defined input properties, default input values, and required inputs for the event directly in your workflow. When you trigger the event, you can provide the `ref` and any `inputs`. When the workflow runs, you can access the input values in the {% ifversion actions-unified-inputs %}`inputs`{% else %}`github.event.inputs`{% endif %} context. For more information, see "[Contexts](/actions/learn-github-actions/contexts)."

{% data reusables.actions.inputs-vs-github-event-inputs %}

{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5511 %}
This example defines inputs called `logLevel`, `tags`, and `environment`. You pass values for these inputs to the workflow when you run it. This workflow then prints the values to the log, using the {% if actions-unified-inputs %}`inputs.logLevel`, `inputs.tags`, and `inputs.environment`{% else %}`github.event.inputs.logLevel`, `github.event.inputs.tags`, and `github.event.inputs.environment`{% endif %} context properties.
This example defines inputs called `logLevel`, `tags`, and `environment`. You pass values for these inputs to the workflow when you run it. This workflow then prints the values to the log, using the {% ifversion actions-unified-inputs %}`inputs.logLevel`, `inputs.tags`, and `inputs.environment`{% else %}`github.event.inputs.logLevel`, `github.event.inputs.tags`, and `github.event.inputs.environment`{% endif %} context properties.

```yaml
on:
Expand Down Expand Up @@ -1288,9 +1288,9 @@ jobs:
echo "Tags: $TAGS"
echo "Environment: $ENVIRONMENT"
env:
LEVEL: {% if actions-unified-inputs %}{% raw %}${{ inputs.logLevel }}{% endraw %}{% else %}{% raw %}${{ github.event.inputs.logLevel }}{% endraw %}{% endif %}
TAGS: {% if actions-unified-inputs %}{% raw %}${{ inputs.tags }}{% endraw %}{% else %}{% raw %}${{ github.event.inputs.tags }}{% endraw %}{% endif %}
ENVIRONMENT: {% if actions-unified-inputs %}{% raw %}${{ inputs.environment }}{% endraw %}{% else %}{% raw %}${{ github.event.inputs.environment }}{% endraw %}{% endif %}
LEVEL: {% ifversion actions-unified-inputs %}{% raw %}${{ inputs.logLevel }}{% endraw %}{% else %}{% raw %}${{ github.event.inputs.logLevel }}{% endraw %}{% endif %}
TAGS: {% ifversion actions-unified-inputs %}{% raw %}${{ inputs.tags }}{% endraw %}{% else %}{% raw %}${{ github.event.inputs.tags }}{% endraw %}{% endif %}
ENVIRONMENT: {% ifversion actions-unified-inputs %}{% raw %}${{ inputs.environment }}{% endraw %}{% else %}{% raw %}${{ github.event.inputs.environment }}{% endraw %}{% endif %}
```

If you run this workflow from a browser you must enter values for the required inputs manually before the workflow will run.
Expand All @@ -1306,7 +1306,7 @@ gh workflow run run-tests.yml -f logLevel=warning -f tags=false -f environment=s
For more information, see the {% data variables.product.prodname_cli %} information in "[Manually running a workflow](/actions/managing-workflow-runs/manually-running-a-workflow)."

{% else %}
This example defines the `name` and `home` inputs and prints them using the {% if actions-unified-inputs %}`inputs.name` and `inputs.home`{% else %}`github.event.inputs.name` and `github.event.inputs.home`{% endif %} contexts. If a `home` isn't provided, the default value 'The Octoverse' is printed.
This example defines the `name` and `home` inputs and prints them using the {% ifversion actions-unified-inputs %}`inputs.name` and `inputs.home`{% else %}`github.event.inputs.name` and `github.event.inputs.home`{% endif %} contexts. If a `home` isn't provided, the default value 'The Octoverse' is printed.

```yaml
name: Manually triggered workflow
Expand All @@ -1330,8 +1330,8 @@ jobs:
echo Hello $NAME!
echo -in $HOME
env:
NAME: {% if actions-unified-inputs %}{% raw %}${{ inputs.name }}{% endraw %}{% else %}{% raw %}${{ github.event.inputs.name }}{% endraw %}{% endif %}
HOME: {% if actions-unified-inputs %}{% raw %}${{ github.event.inputs.home }}{% endraw %}{% else %}{% raw %}${{ github.event.inputs.home }}{% endraw %}{% endif %}
NAME: {% ifversion actions-unified-inputs %}{% raw %}${{ inputs.name }}{% endraw %}{% else %}{% raw %}${{ github.event.inputs.name }}{% endraw %}{% endif %}
HOME: {% ifversion actions-unified-inputs %}{% raw %}${{ github.event.inputs.home }}{% endraw %}{% else %}{% raw %}${{ github.event.inputs.home }}{% endraw %}{% endif %}
```
{% endif %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,10 @@ updates:
prefix-development: "pip dev"
include: "scope"
```
If you use the same configuration as in the example above, bumping the `requests` library in the `pip` development dependency group will generate a commit message of:

`pip dev: bump requests from 1.0.0 to 1.0.1`

### `ignore`

{% data reusables.dependabot.default-dependencies-allow-ignore %}
Expand Down
5 changes: 4 additions & 1 deletion content/get-started/quickstart/create-a-repo.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,10 @@ You can store a variety of projects in {% data variables.product.product_name %}

{% note %}

**Note:** You can create public repositories for an open source project. When creating your public repository, make sure to include a [license file](https://choosealicense.com/) that determines how you want your project to be shared with others. {% data reusables.open-source.open-source-guide-repositories %} {% data reusables.open-source.open-source-learning %}
**Notes:**
- You can create public repositories for an open source project. When creating your public repository, make sure to include a [license file](https://choosealicense.com/) that determines how you want your project to be shared with others. {% data reusables.open-source.open-source-guide-repositories %}
- {% data reusables.open-source.open-source-learning %}
- You can also add community health files to your repositories, to set guidelines on how to contribute, keep your repositories safe, and much more. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)."

{% endnote %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ versions:
ghes: '*'
ghae: '*'
ghec: '*'
redirect_from:
- /github/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections
redirect_from:
- /github/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections
shortTitle: Collapsed sections
---
## Creating a collapsed section
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ versions:
ghes: '*'
ghae: '*'
ghec: '*'
redirect_from:
- /github/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests
redirect_from:
- /github/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests
topics:
- Issues
- Pull requests
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,4 @@ Assets are commonly found in the following locations:
|:----------:|:-----------------------------------------:|:---------------------------------:|
| CSS | `<link rel="stylesheet" href="http://example.com/css/main.css">` | `<link rel="stylesheet" href="https://example.com/css/main.css">`
| JavaScript | `<script type="text/javascript" src="http://example.com/js/main.js"></script>` | `<script type="text/javascript" src="https://example.com/js/main.js"></script>`
| Image | `<A HREF="http://www.somesite.com"><IMG SRC="http://www.example.com/logo.jpg" alt="Logo"></a>` | `<A HREF="https://www.somesite.com"><IMG SRC="https://www.example.com/logo.jpg" alt="Logo"></a>`
| Image | `<a href="http://www.somesite.com"><img src="http://www.example.com/logo.jpg" alt="Logo"></a>` | `<a href="https://www.somesite.com"><img src="https://www.example.com/logo.jpg" alt="Logo"></a>`
6 changes: 2 additions & 4 deletions content/rest/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,7 @@ children:
- /getting-started-with-the-checks-api
---
This section of the documentation is intended to get you up-and-running with
real-world {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API applications. We'll cover everything you need to know, from
authentication, to manipulating results, to combining results with other apps.
Every tutorial here will have a project, and every project will be
stored and documented in our public
real-world {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API applications. We'll go over everything you need to know, from authentication to results manipulation to integrating results with other apps.
Every tutorial will include a project, and each project will be saved and documented in our public
[platform-samples](https://github.com/github/platform-samples) repository.
![The Octocat](/assets/images/electrocat.png)
4 changes: 2 additions & 2 deletions data/features/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The format and allowed values are the same as the [frontmatter versions property
### Liquid conditionals
Now you can use `{% if meow %} ... {% endif %}` in content files! Note this is the `if` tag, not the new `ifversion` tag.
Now you can use `{% ifversion meow %} ... {% endif %}` in content files!

### Frontmatter

Expand All @@ -45,7 +45,7 @@ versions:

## Schema enforcement

The schema for validating the feature versioning lives in [`tests/helpers/schemas/feature-versions-schema.js`](/tests/helpers/schemas/feature-versions-schema.js) and is exercised by [`tests/linting/lint-files.js`](/tests/linting/lint-files.js).
The schema for validating the feature versioning lives in [`tests/helpers/schemas/feature-versions-schema.js`](/tests/helpers/schemas/feature-versions-schema.js) and is exercised by [`tests/linting/lint-versioning.js`](/tests/linting/lint-versioning.js).

## Script to remove feature tags

Expand Down
9 changes: 7 additions & 2 deletions data/graphql/ghae/schema.docs-ghae.graphql
Original file line number Diff line number Diff line change
Expand Up @@ -11750,12 +11750,12 @@ The possible roles for enterprise membership.
"""
enum EnterpriseUserAccountMembershipRole {
"""
The user is a member of the enterprise membership.
The user is a member of an organization in the enterprise.
"""
MEMBER

"""
The user is an owner of the enterprise membership.
The user is an owner of an organization in the enterprise.
"""
OWNER
}
Expand Down Expand Up @@ -32816,6 +32816,11 @@ type Repository implements Node & ProjectOwner & RepositoryInfo & Starrable & Su
"""
squashMergeAllowed: Boolean!

"""
Whether a squash merge commit can use the pull request title as default.
"""
squashPrTitleUsedAsDefault: Boolean!

"""
The SSH URL to clone this repository
"""
Expand Down
14 changes: 12 additions & 2 deletions data/graphql/ghec/schema.docs.graphql
Original file line number Diff line number Diff line change
Expand Up @@ -8174,6 +8174,11 @@ enum DependencyGraphEcosystem {
Ruby gems hosted at RubyGems.org
"""
RUBYGEMS

"""
Rust crates
"""
RUST
}

"""
Expand Down Expand Up @@ -12813,12 +12818,12 @@ The possible roles for enterprise membership.
"""
enum EnterpriseUserAccountMembershipRole {
"""
The user is a member of the enterprise membership.
The user is a member of an organization in the enterprise.
"""
MEMBER

"""
The user is an owner of the enterprise membership.
The user is an owner of an organization in the enterprise.
"""
OWNER
}
Expand Down Expand Up @@ -37285,6 +37290,11 @@ type Repository implements Node & PackageOwner & ProjectOwner & RepositoryInfo &
"""
squashMergeAllowed: Boolean!

"""
Whether a squash merge commit can use the pull request title as default.
"""
squashPrTitleUsedAsDefault: Boolean!

"""
The SSH URL to clone this repository
"""
Expand Down
14 changes: 12 additions & 2 deletions data/graphql/schema.docs.graphql
Original file line number Diff line number Diff line change
Expand Up @@ -8174,6 +8174,11 @@ enum DependencyGraphEcosystem {
Ruby gems hosted at RubyGems.org
"""
RUBYGEMS

"""
Rust crates
"""
RUST
}

"""
Expand Down Expand Up @@ -12813,12 +12818,12 @@ The possible roles for enterprise membership.
"""
enum EnterpriseUserAccountMembershipRole {
"""
The user is a member of the enterprise membership.
The user is a member of an organization in the enterprise.
"""
MEMBER

"""
The user is an owner of the enterprise membership.
The user is an owner of an organization in the enterprise.
"""
OWNER
}
Expand Down Expand Up @@ -37285,6 +37290,11 @@ type Repository implements Node & PackageOwner & ProjectOwner & RepositoryInfo &
"""
squashMergeAllowed: Boolean!

"""
Whether a squash merge commit can use the pull request title as default.
"""
squashPrTitleUsedAsDefault: Boolean!

"""
The SSH URL to clone this repository
"""
Expand Down
2 changes: 1 addition & 1 deletion data/reusables/actions/inputs-vs-github-event-inputs.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{% if actions-unified-inputs %}
{% ifversion actions-unified-inputs %}

{% note %}

Expand Down
Loading

0 comments on commit e8fa298

Please sign in to comment.