Merge branch 'main' into 3420-replica-limit
1
.github/allowed-actions.js
vendored
@@ -27,7 +27,6 @@ module.exports = [
|
||||
"juliangruber/find-pull-request-action@2fc55e82a6d5d36fe1e7f1848f7e64fd02d99de9",
|
||||
"juliangruber/read-file-action@e0a316da496006ffd19142f0fd594a1783f3b512",
|
||||
"lee-dohm/close-matching-issues@22002609b2555fe18f52b8e2e7c07cbf5529e8a8",
|
||||
"octokit/graphql-action@5b3e01d42dee4509b0ac6b1cb2cf7778cdce85c2",
|
||||
"pascalgn/automerge-action@c9bd1823770819dc8fb8a5db2d11a3a95fbe9b07", //pascalgn/automerge@0.12.0
|
||||
"peter-evans/create-issue-from-file@a04ce672e3acedb1f8e416b46716ddfd09905326",
|
||||
"peter-evans/create-or-update-comment@5221bf4aa615e5c6e95bb142f9673a9c791be2cd",
|
||||
|
||||
61
.github/workflows/remove-from-fr-board.yaml
vendored
@@ -13,56 +13,15 @@ jobs:
|
||||
if: github.repository == 'github/docs-internal'
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- id: find_project_cards
|
||||
uses: octokit/graphql-action@5b3e01d42dee4509b0ac6b1cb2cf7778cdce85c2
|
||||
with:
|
||||
query: |
|
||||
query($issue_node_id:ID!) {
|
||||
node(id:$issue_node_id) {
|
||||
... on Issue {
|
||||
projectCards(first: 10) {
|
||||
nodes {
|
||||
id
|
||||
project {
|
||||
name
|
||||
id
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
... on PullRequest {
|
||||
projectCards(first: 10) {
|
||||
nodes {
|
||||
id
|
||||
project {
|
||||
name
|
||||
id
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
issue_node_id: ${{ github.event.client_payload.command.resource.id }}
|
||||
- name: Remove issue from board
|
||||
if: ${{ github.event.client_payload.command.resource.type == 'Issue' }}
|
||||
run: gh issue edit "$ISSUE_URL" --remove-project "Docs content first responder"
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}
|
||||
|
||||
- run: "echo 'Project cards found: ${{ steps.find_project_cards.outputs.data }}'"
|
||||
|
||||
- name: Get FR card
|
||||
GITHUB_TOKEN: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}}
|
||||
ISSUE_URL: https://github.com/${{ github.event.client_payload.command.repository.full_name }}/issues/${{ github.event.client_payload.command.resource.number }}
|
||||
- name: Remove PR from board
|
||||
if: ${{ github.event.client_payload.command.resource.type == 'PullRequest' }}
|
||||
run: gh pr edit "$PR_URL" --remove-project "Docs content first responder"
|
||||
env:
|
||||
QUERY_DATA: ${{ steps.find_project_cards.outputs.data }}
|
||||
run: |
|
||||
echo 'FR_CARDS='$(jq '.node.projectCards.nodes | .[] | select(.project.id == "MDc6UHJvamVjdDQ1NzI0ODI=") | .id' <<< "$QUERY_DATA") >> $GITHUB_ENV
|
||||
|
||||
- name: Delete card
|
||||
id: delete_project_card
|
||||
if: ${{ env.FR_CARDS }}
|
||||
uses: octokit/graphql-action@5b3e01d42dee4509b0ac6b1cb2cf7778cdce85c2
|
||||
with:
|
||||
query: |
|
||||
mutation DeleteCard {
|
||||
deleteProjectCard(input:{cardId:${{ env.FR_CARDS }}}) {deletedCardId}
|
||||
}
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}
|
||||
GITHUB_TOKEN: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}}
|
||||
PR_URL: https://github.com/${{ github.event.client_payload.command.repository.full_name }}/pull/${{ github.event.client_payload.command.resource.number }}
|
||||
|
||||
@@ -19,8 +19,8 @@ jobs:
|
||||
try {
|
||||
await github.projects.createCard({
|
||||
column_id: squadBoardColumnId,
|
||||
content_id: context.payload.issue.id,
|
||||
content_type: "Issue"
|
||||
content_id: context.payload.pull_request.id,
|
||||
content_type: "PullRequest"
|
||||
});
|
||||
} catch (error) {
|
||||
console.log(error);
|
||||
@@ -30,8 +30,8 @@ jobs:
|
||||
try {
|
||||
await github.projects.createCard({
|
||||
column_id: prBoardColumnId,
|
||||
content_id: context.payload.issue.id,
|
||||
content_type: "Issue"
|
||||
content_id: context.payload.pull_request.id,
|
||||
content_type: "PullRequest"
|
||||
});
|
||||
} catch (error) {
|
||||
console.log(error);
|
||||
|
||||
BIN
assets/images/help/organizations/organization-security-tab.png
Normal file
|
After Width: | Height: | Size: 18 KiB |
|
After Width: | Height: | Size: 14 KiB |
BIN
assets/images/help/organizations/security-overview-filters.png
Normal file
|
After Width: | Height: | Size: 4.9 KiB |
BIN
assets/images/help/organizations/security-overview-icons.png
Normal file
|
After Width: | Height: | Size: 13 KiB |
|
After Width: | Height: | Size: 15 KiB |
|
After Width: | Height: | Size: 44 KiB |
BIN
assets/images/help/organizations/security-overview.png
Normal file
|
After Width: | Height: | Size: 72 KiB |
BIN
assets/images/help/teams/org-team-page-security-overview.png
Normal file
|
After Width: | Height: | Size: 17 KiB |
@@ -42,6 +42,7 @@ includeGuides:
|
||||
- /actions/guides/building-and-testing-java-with-maven
|
||||
- /actions/guides/building-and-testing-java-with-gradle
|
||||
- /actions/guides/building-and-testing-java-with-ant
|
||||
- /actions/guides/installing-an-apple-certificate-on-macos-runners-for-xcode-development
|
||||
- /actions/guides/publishing-nodejs-packages
|
||||
- /actions/guides/publishing-java-packages-with-maven
|
||||
- /actions/guides/publishing-java-packages-with-gradle
|
||||
@@ -81,6 +82,7 @@ includeGuides:
|
||||
<!-- {% link_in_list /building-and-testing-java-with-maven %} -->
|
||||
<!-- {% link_in_list /building-and-testing-java-with-gradle %} -->
|
||||
<!-- {% link_in_list /building-and-testing-java-with-ant %} -->
|
||||
<!-- {% link_in_list /installing-an-apple-certificate-on-macos-runners-for-xcode-development %} -->
|
||||
<!-- {% link_in_list /about-packaging-with-github-actions %} -->
|
||||
<!-- {% link_in_list /publishing-nodejs-packages %} -->
|
||||
<!-- {% link_in_list /publishing-java-packages-with-maven %} -->
|
||||
|
||||
@@ -0,0 +1,135 @@
|
||||
---
|
||||
title: Installing an Apple certificate on macOS runners for Xcode development
|
||||
intro: 'You can sign Xcode apps within your continuous integration (CI) workflow by installing an Apple code signing certificate on {% data variables.product.prodname_actions %} runners.'
|
||||
product: '{% data reusables.gated-features.actions %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '>=2.22'
|
||||
github-ae: '*'
|
||||
type: 'tutorial'
|
||||
topics:
|
||||
- 'CI'
|
||||
- 'Xcode'
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
{% data reusables.actions.ae-beta %}
|
||||
|
||||
### Introduction
|
||||
|
||||
This guide shows you how to add a step to your continuous integration (CI) workflow that installs an Apple code signing certificate and provisioning profile on {% data variables.product.prodname_actions %} runners. This will allow you to sign your Xcode apps for publishing to the Apple App Store, or distributing it to test groups.
|
||||
|
||||
### Prerequisites
|
||||
|
||||
You should be familiar with YAML and the syntax for {% data variables.product.prodname_actions %}. For more information, see:
|
||||
|
||||
- "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)"
|
||||
- "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions)"
|
||||
|
||||
You should have an understanding of Xcode app building and signing. For more information, see the [Apple developer documentation](https://developer.apple.com/documentation/).
|
||||
|
||||
### Creating secrets for your certificate and provisioning profile
|
||||
|
||||
The signing process involves storing certificates and provisioning profiles, transferring them to the runner, importing them to the runner's keychain, and using them in your build.
|
||||
|
||||
To use your certificate and provisioning profile on a runner, we strongly recommend that you use {% data variables.product.prodname_dotcom %} secrets. For more information on creating secrets and using them in a workflow, see "[Encrypted secrets](/actions/reference/encrypted-secrets)."
|
||||
|
||||
Create secrets in your repository or organization for the following items:
|
||||
|
||||
* Your Apple signing certificate.
|
||||
|
||||
- This is your `p12` certificate file. For more information on exporting your signing certificate from Xcode, see the [Xcode documentation](https://help.apple.com/xcode/mac/current/#/dev154b28f09).
|
||||
|
||||
- You should convert your certificate to Base64 when saving it as a secret. In this example, the secret is named `BUILD_CERTIFICATE_BASE64`.
|
||||
|
||||
- Use the following command to convert your certificate to Base64 and copy it to your clipboard:
|
||||
|
||||
```shell
|
||||
base64 <em>build_certificate</em>.p12 | pbcopy
|
||||
```
|
||||
* The password for your Apple signing certificate.
|
||||
- In this example, the secret is named `P12_PASSWORD`.
|
||||
|
||||
* Your Apple provisioning profile.
|
||||
|
||||
- For more information on exporting your provisioning profile from Xcode, see the [Xcode documentation](https://help.apple.com/xcode/mac/current/#/deva899b4fe5).
|
||||
|
||||
- You should convert your provisioning profile to Base64 when saving it as a secret. In this example, the secret is named `BUILD_PROVISION_PROFILE_BASE64`.
|
||||
|
||||
- Use the following command to convert your provisioning profile to Base64 and copy it to your clipboard:
|
||||
|
||||
```shell
|
||||
base64 <em>provisioning_profile.mobileprovision</em> | pbcopy
|
||||
```
|
||||
|
||||
* A keychain password.
|
||||
|
||||
- A new keychain will be created on the runner, so the password for the new keychain can be any new random string. In this example, the secret is named `KEYCHAIN_PASSWORD`.
|
||||
|
||||
### Add a step to your workflow
|
||||
|
||||
This example workflow includes a step that imports the Apple certificate and provisioning profile from the {% data variables.product.prodname_dotcom %} secrets, and installs them on the runner.
|
||||
|
||||
{% raw %}
|
||||
```yaml{:copy}
|
||||
name: App build
|
||||
on: push
|
||||
|
||||
jobs:
|
||||
build_with_signing:
|
||||
runs-on: macos-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v2
|
||||
- name: Install the Apple certificate and provisioning profile
|
||||
env:
|
||||
BUILD_CERTIFICATE_BASE64: ${{ secrets.BUILD_CERTIFICATE_BASE64 }}
|
||||
P12_PASSWORD: ${{ secrets.P12_PASSWORD }}
|
||||
BUILD_PROVISION_PROFILE_BASE64: ${{ secrets.BUILD_PROVISION_PROFILE_BASE64 }}
|
||||
KEYCHAIN_PASSWORD: ${{ secrets.KEYCHAIN_PASSWORD }}
|
||||
run: |
|
||||
# create variables
|
||||
CERTIFICATE_PATH=$RUNNER_TEMP/build_certificate.p12
|
||||
PP_PATH=$RUNNER_TEMP/build_pp.mobileprovision
|
||||
KEYCHAIN_PATH=$RUNNER_TEMP/app-signing.keychain-db
|
||||
|
||||
# import certificate and provisioning profile from secrets
|
||||
echo -n "$BUILD_CERTIFICATE_BASE64" | base64 --decode --output $CERTIFICATE_PATH
|
||||
echo -n "$BUILD_PROVISION_PROFILE_BASE64" | base64 --decode --output $PP_PATH
|
||||
|
||||
# create temporary keychain
|
||||
security create-keychain -p $KEYCHAIN_PASSWORD $KEYCHAIN_PATH
|
||||
security set-keychain-settings -lut 21600 $KEYCHAIN_PATH
|
||||
security unlock-keychain -p $KEYCHAIN_PASSWORD $KEYCHAIN_PATH
|
||||
|
||||
# import certificate to keychain
|
||||
security import $CERTIFICATE_PATH -P $P12_PASSWORD -A -t cert -f pkcs12 -k $KEYCHAIN_PATH
|
||||
security list-keychain -d user -s $KEYCHAIN_PATH
|
||||
|
||||
# apply provisioning profile
|
||||
mkdir -p ~/Library/MobileDevice/Provisioning\ Profiles
|
||||
cp $PP_PATH ~/Library/MobileDevice/Provisioning\ Profiles
|
||||
- name: Build app
|
||||
...
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
### Required clean-up on self-hosted runners
|
||||
|
||||
{% data variables.product.prodname_dotcom %}-hosted runners are isolated virtual machines that are automatically destroyed at the end of the job execution. This means that the certificates and provisioning profile used on the runner during the job will be destroyed with the runner when the job is completed.
|
||||
|
||||
On self-hosted runners, the `$RUNNER_TEMP` directory is cleaned up at the end of the job execution, but the keychain and provisioning profile might still exist on the runner.
|
||||
|
||||
If you use self-hosted runners, you should add a final step to your workflow to help ensure that these sensitive files are deleted at the end of the job. The workflow step shown below is an example of how to do this.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
- name: Clean up keychain and provisioning profile
|
||||
if: ${{ always() }}
|
||||
run: |
|
||||
security delete-keychain $RUNNER_TEMP/app-signing.keychain-db
|
||||
rm ~/Library/MobileDevice/Provisioning\ Profiles/build_pp.mobileprovision
|
||||
```
|
||||
{% endraw %}
|
||||
@@ -54,6 +54,7 @@ We strongly recommend that actions use environment variables to access the files
|
||||
| `GITHUB_WORKFLOW` | The name of the workflow. |
|
||||
| `GITHUB_RUN_ID` | {% data reusables.github-actions.run_id_description %} |
|
||||
| `GITHUB_RUN_NUMBER` | {% data reusables.github-actions.run_number_description %} |
|
||||
| `GITHUB_JOB` | The [job_id](/actions/reference/workflow-syntax-for-github-actions#jobsjob_id) of the current job. |
|
||||
| `GITHUB_ACTION` | The unique identifier (`id`) of the action. |
|
||||
| `GITHUB_ACTIONS` | Always set to `true` when {% data variables.product.prodname_actions %} is running the workflow. You can use this variable to differentiate when tests are being run locally or by {% data variables.product.prodname_actions %}.
|
||||
| `GITHUB_ACTOR` | The name of the person or app that initiated the workflow. For example, `octocat`. |
|
||||
|
||||
@@ -122,7 +122,7 @@ The `paths-ignore` and `paths` keywords accept glob patterns that use the `*` an
|
||||
|
||||
#### Example ignoring paths
|
||||
|
||||
Anytime a path name matches a pattern in `paths-ignore`, the workflow will not run. {% data variables.product.prodname_dotcom %} evaluates patterns defined in `paths-ignore` against the path name. A workflow with the following path filter will only run on `push` events that include at least one file outside the `docs` directory at the root of the repository.
|
||||
When all the path names match patterns in `paths-ignore`, the workflow will not run. {% data variables.product.prodname_dotcom %} evaluates patterns defined in `paths-ignore` against the path name. A workflow with the following path filter will only run on `push` events that include at least one file outside the `docs` directory at the root of the repository.
|
||||
|
||||
```yaml
|
||||
on:
|
||||
|
||||
@@ -19,3 +19,5 @@ topics:
|
||||
{% link_with_intro /security-advisories %}
|
||||
|
||||
{% link_with_intro /supply-chain-security %}
|
||||
|
||||
{% link_with_intro /security-overview %}
|
||||
|
||||
@@ -14,7 +14,7 @@ topics:
|
||||
|
||||
To give people instructions for responsibly reporting security vulnerabilities in your project, you can add a _SECURITY.md_ file to your repository's root, `docs`, or `.github` folder. When someone creates an issue in your repository, they will see a link to your project's security policy.
|
||||
|
||||
You can create a default security policy for your organization or user account. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file)."
|
||||
You can create a default security policy for your organization or user account. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)."
|
||||
|
||||
{% tip %}
|
||||
|
||||
@@ -43,5 +43,5 @@ After someone reports a security vulnerability in your project, you can use {% d
|
||||
### Further reading
|
||||
|
||||
- "[About securing your repository](/github/administering-a-repository/about-securing-your-repository)"
|
||||
- "[Setting up your project for healthy contributions](/github/building-a-strong-community/setting-up-your-project-for-healthy-contributions)"
|
||||
- "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)"
|
||||
- [{% data variables.product.prodname_security %}]({% data variables.product.prodname_security_link %})
|
||||
|
||||
@@ -0,0 +1,120 @@
|
||||
---
|
||||
title: Exploring security alerts
|
||||
intro: 'You can view, filter, and sort security alerts for repositories owned by your organization or team in one place.'
|
||||
product: '{% data reusables.gated-features.security-center %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
github-ae: 'next'
|
||||
---
|
||||
|
||||
{% data reusables.security-center.beta %}
|
||||
|
||||
### About the security overview
|
||||
|
||||
You can use the security overview for a high-level view of the security status of your organization or to identify problematic repositories that require intervention. At the organization-level, the security overview displays aggregate and repository-specific security information for repositories owned by your organization. At the team-level, the security overview displays repository-specific security information for repositories that the team has admin privileges for. For more information, see "[Managing team access to an organization repository](/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-repository)."
|
||||
|
||||
The security overview indicates whether {% data variables.product.prodname_GH_advanced_security %} features are enabled for repositories owned by your organization and consolidates alerts from {% data variables.product.prodname_advanced_security %} features, including {% data variables.product.prodname_code_scanning %} alerts, {% data variables.product.prodname_dependabot_alerts %}, and {% data variables.product.prodname_secret_scanning %} alerts. For more information, see "[About securing your repository](/code-security/getting-started/about-securing-your-repository)."
|
||||
|
||||
In the security overview, you can view, sort, and filter alerts to understand the security risks in your organization and in specific repositories. You can apply multiple filters to focus on areas of interest. For example, you can identify private repositories that have a high number of {% data variables.product.prodname_dependabot_alerts %} or repositories that have no {% data variables.product.prodname_code_scanning %} alerts.
|
||||
|
||||

|
||||
|
||||
For each repository in the security overview, you will see icons for each type of {% data variables.product.prodname_advanced_security %} feature and how many alerts there are of each type. If an {% data variables.product.prodname_advanced_security %} feature is not enabled for a repository, the icon for that feature will be grayed out.
|
||||
|
||||

|
||||
|
||||
| Icon | Meaning |
|
||||
| -------- | -------- |
|
||||
| {% octicon "code-square" aria-label="Code scanning alerts" %} | {% data variables.product.prodname_code_scanning_capc %} alerts. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-code-scanning)." |
|
||||
| {% octicon "key" aria-label="Secret scanning alerts" %} | {% data variables.product.prodname_secret_scanning_caps %} alerts. For more information, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning)." |
|
||||
| {% octicon "hubot" aria-label="Dependabot alerts" %} | {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." |
|
||||
| {% octicon "check" aria-label="Check" %} | The {% data variables.product.prodname_advanced_security %} feature is enabled, but does not raise alerts in this repository. |
|
||||
| {% octicon "x" aria-label="x" %} | The {% data variables.product.prodname_advanced_security %} feature is not supported in this repository. |
|
||||
|
||||
By default, archived repositories are excluded from the security overview for an organization. You can apply filters to view archived repositories in the security overview. For more information, see "[Filtering the list of alerts](#filtering-the-list-of-alerts)."
|
||||
|
||||
The security overview displays active alerts raised by {% data variables.product.prodname_GH_advanced_security %} features. If there are no alerts in the security overview for a repository, undetected security vulnerabilities or code errors may still exist.
|
||||
|
||||
### Viewing the security overview for an organization
|
||||
|
||||
Organization owners can view the security overview for an organization.
|
||||
|
||||
{% data reusables.organizations.navigate-to-org %}
|
||||
{% data reusables.organizations.security-overview %}
|
||||
1. To view aggregate information about alert types, click **Show more**.
|
||||

|
||||
{% data reusables.organizations.filter-security-overview %}
|
||||
|
||||
### Viewing the security overview for a team
|
||||
|
||||
Members of a team can see the security overview for repositories that the team has admin privileges for.
|
||||
|
||||
{% data reusables.profile.access_profile %}
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.organizations.specific_team %}
|
||||
{% data reusables.organizations.team-security-overview %}
|
||||
{% data reusables.organizations.filter-security-overview %}
|
||||
|
||||
### Filtering the list of alerts
|
||||
|
||||
#### Filter by level of risk for repositories
|
||||
|
||||
The level of risk for a repository is determined by the number and severity of alerts from {% data variables.product.prodname_advanced_security %} features. If one or more {% data variables.product.prodname_advanced_security %} features are not enabled for a repository, the repository will have an unknown level of risk. If a repository has no risks that are detected by {% data variables.product.prodname_advanced_security %} features, the repository will have a clear level of risk.
|
||||
|
||||
| Qualifier | Description |
|
||||
| -------- | -------- |
|
||||
| `risk:high` | Display repositories that are at high risk. |
|
||||
| `risk:medium` | Display repositories that are at medium risk. |
|
||||
| `risk:low` | Display repositories that are at low risk. |
|
||||
| `risk:unknown` | Display repositories that are at an unknown level of risk. |
|
||||
| `risk:clear` | Display repositories that have no detected level of risk. |
|
||||
|
||||
#### Filter by number of alerts
|
||||
|
||||
| Qualifier | Description |
|
||||
| -------- | -------- |
|
||||
| <code>code-scanning-alerts:<em>n</em></code> | Display repositories that have *n* {% data variables.product.prodname_code_scanning %} alerts. This qualifier can use > and < comparison operators. |
|
||||
| <code>secret-scanning-alerts:<em>n</em></code> | Display repositories that have *n* {% data variables.product.prodname_secret_scanning %} alerts. This qualifier can use > and < comparison operators. |
|
||||
| <code>dependabot-alerts:<em>n</em></code> | Display repositories that have *n* {% data variables.product.prodname_dependabot_alerts %}. This qualifier can use > and < comparison operators. |
|
||||
|
||||
#### Filter by whether {% data variables.product.prodname_advanced_security %} features are enabled
|
||||
|
||||
| Qualifier | Description |
|
||||
| -------- | -------- |
|
||||
| `enabled:code-scanning` | Display repositories that have {% data variables.product.prodname_code_scanning %} enabled. |
|
||||
| `not-enabled:code-scanning` | Display repositories that do not have {% data variables.product.prodname_code_scanning %} enabled. |
|
||||
| `enabled:secret-scanning` | Display repositories that have {% data variables.product.prodname_secret_scanning %} enabled. |
|
||||
| `not-enabled:secret-scanning` | Display repositories that have {% data variables.product.prodname_secret_scanning %} enabled. |
|
||||
| `enabled:dependabot-alerts` | Display repositories that have {% data variables.product.prodname_dependabot_alerts %} enabled. |
|
||||
| `not-enabled:dependabot-alerts` | Display repositories that do not have {% data variables.product.prodname_dependabot_alerts %} enabled. |
|
||||
|
||||
#### Filter by repository type
|
||||
|
||||
| Qualifier | Description |
|
||||
| -------- | -------- |
|
||||
| `is:public` | Display public repositories. |
|
||||
| `is:internal` | Display internal repositories. |
|
||||
| `is:private` | Display private repositories. |
|
||||
| `archived:true` | Display archived repositories. |
|
||||
|
||||
#### Filter by team
|
||||
|
||||
| Qualifier | Description |
|
||||
| -------- | -------- |
|
||||
| <code>team:<em>TEAM-NAME</em></code> | Displays repositories that *TEAM-NAME* has admin privileges for. |
|
||||
|
||||
#### Filter by topic
|
||||
|
||||
| Qualifier | Description |
|
||||
| -------- | -------- |
|
||||
| <code>topic:<em>TOPIC-NAME</em></code> | Displays repositories that are classified with *TOPIC-NAME*. |
|
||||
|
||||
#### Sort the list of alerts
|
||||
|
||||
| Qualifier | Description |
|
||||
| -------- | -------- |
|
||||
| `sort:risk` | Sorts the repositories in your security overview by risk. |
|
||||
| `sort:repos` | Sorts the repositories in your security overview alphabetically by name. |
|
||||
| `sort:code-scanning-alerts` | Sorts the repositories in your security overview by number of {% data variables.product.prodname_code_scanning %} alerts. |
|
||||
| `sort:secret-scanning-alerts` | Sorts the repositories in your security overview by number of {% data variables.product.prodname_secret_scanning %} alerts. |
|
||||
| `sort:dependabot-alerts` | Sorts the repositories in your security overview by number of {% data variables.product.prodname_dependabot_alerts %}. |
|
||||
13
content/code-security/security-overview/index.md
Normal file
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: Viewing security alerts for repositories in your organization
|
||||
shortTitle: Security overview
|
||||
intro: 'View, sort, and filter the security alerts from across your organization in one place.'
|
||||
product: '{% data reusables.gated-features.security-center %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
github-ae: 'next'
|
||||
---
|
||||
|
||||
### Table of Contents
|
||||
|
||||
{% link_in_list /exploring-security-alerts %}
|
||||
@@ -4,6 +4,7 @@ intro: 'You can host documentation for your repository in a wiki, so that others
|
||||
redirect_from:
|
||||
- /articles/about-github-wikis/
|
||||
- /articles/about-wikis
|
||||
- /github/building-a-strong-community/about-wikis
|
||||
product: '{% data reusables.gated-features.wikis %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
@@ -19,12 +20,12 @@ With wikis, you can write content just like everywhere else on {% data variables
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}If you create a wiki in a public repository, the wiki is available to {% if enterpriseServerVersions contains currentVersion %}anyone with access to {% data variables.product.product_location %}{% else %}the public{% endif %}. {% endif %}If you create a wiki in an internal or private repository, {% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}people{% elsif currentVersion == "github-ae@latest" %}enterprise members{% endif %} with access to the repository can also access the wiki. For more information, see "[Setting repository visibility](/articles/setting-repository-visibility)."
|
||||
|
||||
You can edit wikis directly on {% data variables.product.product_name %}, or you can edit wiki files locally. By default, only people with write access to your repository can make changes to wikis, although you can allow everyone on {% data variables.product.product_location %} to contribute to a wiki in {% if currentVersion == "github-ae@latest" %}an internal{% else %}a public{% endif %} repository. For more information, see "[Changing access permissions for wikis](/articles/changing-access-permissions-for-wikis)".
|
||||
You can edit wikis directly on {% data variables.product.product_name %}, or you can edit wiki files locally. By default, only people with write access to your repository can make changes to wikis, although you can allow everyone on {% data variables.product.product_location %} to contribute to a wiki in {% if currentVersion == "github-ae@latest" %}an internal{% else %}a public{% endif %} repository. For more information, see "[Changing access permissions for wikis](/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis)".
|
||||
|
||||
### Further reading
|
||||
|
||||
- "[Adding or editing wiki pages](/articles/adding-or-editing-wiki-pages)"
|
||||
- "[Creating a footer or sidebar for your wiki](/articles/creating-a-footer-or-sidebar-for-your-wiki)"
|
||||
- "[Editing wiki content](/articles/editing-wiki-content)"
|
||||
- "[Adding or editing wiki pages](/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages)"
|
||||
- "[Creating a footer or sidebar for your wiki](/communities/documenting-your-project-with-wikis/creating-a-footer-or-sidebar-for-your-wiki)"
|
||||
- "[Editing wiki content](/communities/documenting-your-project-with-wikis/editing-wiki-content)"
|
||||
- "[Viewing a wiki's history of changes](/articles/viewing-a-wiki-s-history-of-changes)"
|
||||
- "[Searching wikis](/articles/searching-wikis)"
|
||||
@@ -7,6 +7,7 @@ redirect_from:
|
||||
- /articles/adding-and-editing-wik-pages-locally/
|
||||
- /articles/adding-and-editing-wiki-pages-locally/
|
||||
- /articles/adding-or-editing-wiki-pages
|
||||
- /github/building-a-strong-community/adding-or-editing-wiki-pages
|
||||
product: '{% data reusables.gated-features.wikis %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
@@ -4,6 +4,7 @@ intro: 'Only repository collaborators can edit a public repository''s wiki by de
|
||||
product: '{% data reusables.gated-features.wikis %}'
|
||||
redirect_from:
|
||||
- /articles/changing-access-permissions-for-wikis
|
||||
- /github/building-a-strong-community/changing-access-permissions-for-wikis
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -19,4 +20,4 @@ topics:
|
||||
|
||||
### Further reading
|
||||
|
||||
- "[Disabling wikis](/articles/disabling-wikis)"
|
||||
- "[Disabling wikis](/communities/documenting-your-project-with-wikis/disabling-wikis)"
|
||||
@@ -5,6 +5,7 @@ redirect_from:
|
||||
- /articles/creating-a-footer/
|
||||
- /articles/creating-a-sidebar/
|
||||
- /articles/creating-a-footer-or-sidebar-for-your-wiki
|
||||
- /github/building-a-strong-community/creating-a-footer-or-sidebar-for-your-wiki
|
||||
product: '{% data reusables.gated-features.wikis %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
@@ -4,6 +4,7 @@ intro: You can disable your repository's wiki.
|
||||
product: '{% data reusables.gated-features.wikis %}'
|
||||
redirect_from:
|
||||
- /articles/disabling-wikis
|
||||
- /github/building-a-strong-community/disabling-wikis
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -21,4 +22,4 @@ When you turn off a wiki, the content is hidden, but not erased. If you choose t
|
||||
|
||||
### Further reading
|
||||
|
||||
- "[Changing access permissions for wikis](/articles/changing-access-permissions-for-wikis)"
|
||||
- "[Changing access permissions for wikis](/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis)"
|
||||
@@ -10,6 +10,7 @@ redirect_from:
|
||||
- /articles/adding-images-to-wikis/
|
||||
- /articles/supported-mediawiki-formats/
|
||||
- /articles/editing-wiki-content
|
||||
- /github/building-a-strong-community/editing-wiki-content
|
||||
product: '{% data reusables.gated-features.wikis %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
@@ -0,0 +1,25 @@
|
||||
---
|
||||
title: Documenting your project with wikis
|
||||
shortTitle: Using wikis
|
||||
intro: 'You can use a wiki to share detailed, long-form information about your project.'
|
||||
redirect_from:
|
||||
- /categories/49/articles/
|
||||
- /categories/wiki/
|
||||
- /articles/documenting-your-project-with-wikis
|
||||
- /github/building-a-strong-community/documenting-your-project-with-wikis
|
||||
product: '{% data reusables.gated-features.wikis %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- community
|
||||
---
|
||||
|
||||
{% link_in_list /about-wikis %}
|
||||
{% link_in_list /adding-or-editing-wiki-pages %}
|
||||
{% link_in_list /creating-a-footer-or-sidebar-for-your-wiki %}
|
||||
{% link_in_list /editing-wiki-content %}
|
||||
{% link_in_list /viewing-a-wikis-history-of-changes %}
|
||||
{% link_in_list /changing-access-permissions-for-wikis %}
|
||||
{% link_in_list /disabling-wikis %}
|
||||
@@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.wikis %}'
|
||||
redirect_from:
|
||||
- /articles/viewing-a-wiki-s-history-of-changes
|
||||
- /articles/viewing-a-wikis-history-of-changes
|
||||
- /github/building-a-strong-community/viewing-a-wikis-history-of-changes
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
19
content/communities/index.md
Normal file
@@ -0,0 +1,19 @@
|
||||
---
|
||||
title: Building communities
|
||||
intro: 'Whether your project is open source or private, you can build a healthy and effective environment for collaboration.'
|
||||
redirect_from:
|
||||
- /categories/building-a-strong-community
|
||||
- /github/building-a-strong-community
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- community
|
||||
---
|
||||
|
||||
{% link_with_intro /setting-up-your-project-for-healthy-contributions %}
|
||||
{% link_with_intro /using-templates-to-encourage-useful-issues-and-pull-requests %}
|
||||
{% link_with_intro /moderating-comments-and-conversations %}
|
||||
{% link_with_intro /maintaining-your-safety-on-github %}
|
||||
{% link_with_intro /documenting-your-project-with-wikis %}
|
||||
@@ -3,6 +3,7 @@ title: Blocking a user from your organization
|
||||
intro: Organization owners can block a user to remove the user's ability to collaborate in the organization's repositories.
|
||||
redirect_from:
|
||||
- /articles/blocking-a-user-from-your-organization
|
||||
- /github/building-a-strong-community/blocking-a-user-from-your-organization
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
@@ -11,11 +12,11 @@ topics:
|
||||
|
||||
You can block a user from within your organization's settings or from a specific comment made by the user. When you block a user in a comment, you can choose to send the user a notification explaining that they were blocked and why. Otherwise, the user is not directly notified that you've blocked them. Blocked users can still delete their existing content.
|
||||
|
||||
When you block a user, you can choose to block them indefinitely or for a specific amount of time. If you block someone for a specific amount of time, they are automatically unblocked after the chosen time expires. If you block someone indefinitely, you can unblock them manually at any time. For more information, see "[Unblocking a user from your organization](/articles/unblocking-a-user-from-your-organization)."
|
||||
When you block a user, you can choose to block them indefinitely or for a specific amount of time. If you block someone for a specific amount of time, they are automatically unblocked after the chosen time expires. If you block someone indefinitely, you can unblock them manually at any time. For more information, see "[Unblocking a user from your organization](/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization)."
|
||||
|
||||
{% tip %}
|
||||
|
||||
**Tip:** If you're blocking a user because of a heated conversation, consider locking the conversation so only collaborators can comment. For more information, see "[Locking conversations](/github/building-a-strong-community/locking-conversations)."
|
||||
**Tip:** If you're blocking a user because of a heated conversation, consider locking the conversation so only collaborators can comment. For more information, see "[Locking conversations](/communities/moderating-comments-and-conversations/locking-conversations)."
|
||||
|
||||
{% endtip %}
|
||||
|
||||
@@ -67,8 +68,8 @@ In your organization's repositories, blocked users also cannot:
|
||||
|
||||
### Further reading
|
||||
|
||||
- "[Viewing users who are blocked from your organization](/articles/viewing-users-who-are-blocked-from-your-organization)"
|
||||
- "[Unblocking a user from your organization](/articles/unblocking-a-user-from-your-organization)"
|
||||
- "[Blocking a user from your personal account](/articles/blocking-a-user-from-your-personal-account)"
|
||||
- "[Unblocking a user from your personal account](/articles/unblocking-a-user-from-your-personal-account)"
|
||||
- "[Reporting abuse or spam](/articles/reporting-abuse-or-spam)"
|
||||
- "[Viewing users who are blocked from your organization](/communities/maintaining-your-safety-on-github/viewing-users-who-are-blocked-from-your-organization)"
|
||||
- "[Unblocking a user from your organization](/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization)"
|
||||
- "[Blocking a user from your personal account](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-personal-account)"
|
||||
- "[Unblocking a user from your personal account](/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-personal-account)"
|
||||
- "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)"
|
||||
@@ -3,6 +3,7 @@ title: Blocking a user from your personal account
|
||||
intro: 'You can block a user to deny them access to your activity and repositories, and to prevent them from sending you notifications.'
|
||||
redirect_from:
|
||||
- /articles/blocking-a-user-from-your-personal-account
|
||||
- /github/building-a-strong-community/blocking-a-user-from-your-personal-account
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
@@ -15,7 +16,7 @@ You can block a user in your account settings or from the user's profile. {% dat
|
||||
|
||||
{% tip %}
|
||||
|
||||
**Tip:** If you're blocking a user because of a heated conversation, consider locking the conversation so only collaborators can comment. For more information, see "[Locking conversations](/github/building-a-strong-community/locking-conversations)."
|
||||
**Tip:** If you're blocking a user because of a heated conversation, consider locking the conversation so only collaborators can comment. For more information, see "[Locking conversations](/communities/moderating-comments-and-conversations/locking-conversations)."
|
||||
|
||||
{% endtip %}
|
||||
|
||||
@@ -74,9 +75,9 @@ Use {% data variables.contact.report_abuse %} to contact us if you're being hara
|
||||
|
||||
### Further reading
|
||||
|
||||
- "[Viewing users you've blocked from your personal account](/articles/viewing-users-you-ve-blocked-from-your-personal-account)"
|
||||
- "[Unblocking a user from your personal account](/articles/unblocking-a-user-from-your-personal-account)"
|
||||
- "[Blocking a user from your organization](/articles/blocking-a-user-from-your-organization)"
|
||||
- "[Unblocking a user from your organization](/articles/unblocking-a-user-from-your-organization)"
|
||||
- "[Reporting abuse or spam](/articles/reporting-abuse-or-spam)"
|
||||
- "[Limiting interactions with your repository](/articles/limiting-interactions-with-your-repository)"
|
||||
- "[Viewing users you've blocked from your personal account](/communities/maintaining-your-safety-on-github/viewing-users-youve-blocked-from-your-personal-account)"
|
||||
- "[Unblocking a user from your personal account](/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-personal-account)"
|
||||
- "[Blocking a user from your organization](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)"
|
||||
- "[Unblocking a user from your organization](/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization)"
|
||||
- "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)"
|
||||
- "[Limiting interactions in your repository](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)"
|
||||
@@ -1,15 +1,23 @@
|
||||
---
|
||||
title: Maintaining your safety on GitHub
|
||||
shortTitle: Maintaining safety
|
||||
intro: 'To build a positive and safe environment for yourself and the community for your project on {% data variables.product.prodname_dotcom %}, you can block and unblock users and report disruptive content.'
|
||||
mapTopic: true
|
||||
redirect_from:
|
||||
- /articles/encouraging-positive-contributions-in-your-organization
|
||||
- /github/setting-up-and-managing-organizations-and-teams/encouraging-positive-contributions-in-your-organization
|
||||
- /github/building-a-strong-community/encouraging-positive-contributions-to-your-project
|
||||
- /articles/encouraging-positive-contributions-to-your-project
|
||||
- /github/building-a-strong-community/maintaining-your-safety-on-github
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- community
|
||||
---
|
||||
|
||||
{% link_in_list /blocking-a-user-from-your-personal-account %}
|
||||
{% link_in_list /viewing-users-youve-blocked-from-your-personal-account %}
|
||||
{% link_in_list /unblocking-a-user-from-your-personal-account %}
|
||||
{% link_in_list /blocking-a-user-from-your-organization %}
|
||||
{% link_in_list /viewing-users-who-are-blocked-from-your-organization %}
|
||||
{% link_in_list /unblocking-a-user-from-your-organization %}
|
||||
{% link_in_list /reporting-abuse-or-spam %}
|
||||
@@ -3,6 +3,7 @@ title: Reporting abuse or spam
|
||||
intro: You can report behavior and content that violates community guidelines and terms.
|
||||
redirect_from:
|
||||
- /articles/reporting-abuse-or-spam
|
||||
- /github/building-a-strong-community/reporting-abuse-or-spam
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
@@ -59,9 +60,9 @@ If reported content is enabled for a public repository, you can also report cont
|
||||
|
||||
### Further reading
|
||||
|
||||
- "[Setting up your project for healthy contributions](/articles/setting-up-your-project-for-healthy-contributions)"
|
||||
- "[Using templates to encourage useful issues and pull requests](/github/building-a-strong-community/using-templates-to-encourage-useful-issues-and-pull-requests)"
|
||||
- "[Managing disruptive comments](/articles/managing-disruptive-comments)"{% if currentVersion == "free-pro-team@latest" %}
|
||||
- "[Maintaining your safety on {% data variables.product.prodname_dotcom %}](/github/building-a-strong-community/maintaining-your-safety-on-github)"
|
||||
- "[Limiting interactions in your repository](/github/building-a-strong-community/limiting-interactions-in-your-repository)"{% endif %}
|
||||
- "[Tracking changes in a comment](/articles/tracking-changes-in-a-comment)"
|
||||
- "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)"
|
||||
- "[Using templates to encourage useful issues and pull requests](/communities/using-templates-to-encourage-useful-issues-and-pull-requests)"
|
||||
- "[Managing disruptive comments](/communities/moderating-comments-and-conversations/managing-disruptive-comments)"{% if currentVersion == "free-pro-team@latest" %}
|
||||
- "[Maintaining your safety on {% data variables.product.prodname_dotcom %}](/communities/maintaining-your-safety-on-github)"
|
||||
- "[Limiting interactions in your repository](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)"{% endif %}
|
||||
- "[Tracking changes in a comment](/communities/moderating-comments-and-conversations/tracking-changes-in-a-comment)"
|
||||
@@ -3,6 +3,7 @@ title: Unblocking a user from your organization
|
||||
intro: 'Organization owners can unblock a user who was previously blocked, restoring their access to the organization''s repositories.'
|
||||
redirect_from:
|
||||
- /articles/unblocking-a-user-from-your-organization
|
||||
- /github/building-a-strong-community/unblocking-a-user-from-your-organization
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
@@ -37,7 +38,7 @@ If you selected a specific amount of time to block the user, they will be automa
|
||||
|
||||
### Further reading
|
||||
|
||||
- "[Blocking a user from your organization](/articles/blocking-a-user-from-your-organization)"
|
||||
- "[Blocking a user from your personal account](/articles/blocking-a-user-from-your-personal-account)"
|
||||
- "[Unblocking a user from your personal account](/articles/unblocking-a-user-from-your-personal-account)"
|
||||
- "[Reporting abuse or spam](/articles/reporting-abuse-or-spam)"
|
||||
- "[Blocking a user from your organization](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)"
|
||||
- "[Blocking a user from your personal account](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-personal-account)"
|
||||
- "[Unblocking a user from your personal account](/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-personal-account)"
|
||||
- "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)"
|
||||
@@ -3,6 +3,7 @@ title: Unblocking a user from your personal account
|
||||
intro: 'If you''ve mended fences with a {% data variables.product.prodname_dotcom %} user you''ve blocked, you can unblock their account.'
|
||||
redirect_from:
|
||||
- /articles/unblocking-a-user-from-your-personal-account
|
||||
- /github/building-a-strong-community/unblocking-a-user-from-your-personal-account
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
@@ -38,7 +39,7 @@ You can unblock a user in your account settings or from the user's profile page.
|
||||
|
||||
### Further reading
|
||||
|
||||
- "[Blocking a user from your personal account](/articles/blocking-a-user-from-your-personal-account)"
|
||||
- "[Blocking a user from your organization](/articles/blocking-a-user-from-your-organization)"
|
||||
- "[Unblocking a user from your organization](/articles/unblocking-a-user-from-your-organization)"
|
||||
- "[Reporting abuse or spam](/articles/reporting-abuse-or-spam)"
|
||||
- "[Blocking a user from your personal account](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-personal-account)"
|
||||
- "[Blocking a user from your organization](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)"
|
||||
- "[Unblocking a user from your organization](/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization)"
|
||||
- "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)"
|
||||
@@ -3,6 +3,7 @@ title: Viewing users who are blocked from your organization
|
||||
intro: 'You can view a list of all users whom you or other owners have blocked from your organization. If a user was blocked for a specific amount of time, you can see the amount of time they were blocked for.'
|
||||
redirect_from:
|
||||
- /articles/viewing-users-who-are-blocked-from-your-organization
|
||||
- /github/building-a-strong-community/viewing-users-who-are-blocked-from-your-organization
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
@@ -18,6 +19,6 @@ topics:
|
||||
|
||||
### Further reading
|
||||
|
||||
- "[Blocking a user from your organization](/articles/blocking-a-user-from-your-organization)"
|
||||
- "[Unblocking a user from your organization](/articles/unblocking-a-user-from-your-organization)"
|
||||
- "[Blocking a user from your organization](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)"
|
||||
- "[Unblocking a user from your organization](/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization)"
|
||||
- "[Viewing users you've blocked from your personal account](/articles/viewing-users-you-ve-blocked-from-your-personal-account)"
|
||||
@@ -4,6 +4,7 @@ intro: You can view a list of all users you've blocked from your personal accoun
|
||||
redirect_from:
|
||||
- /articles/viewing-users-you-ve-blocked-from-your-personal-account
|
||||
- /articles/viewing-users-youve-blocked-from-your-personal-account
|
||||
- /github/building-a-strong-community/viewing-users-youve-blocked-from-your-personal-account
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
@@ -17,6 +18,6 @@ topics:
|
||||
|
||||
### Further reading
|
||||
|
||||
- "[Blocking a user from your personal account](/articles/blocking-a-user-from-your-personal-account)"
|
||||
- "[Unblocking a user from your personal account](/articles/unblocking-a-user-from-your-personal-account)"
|
||||
- "[Viewing users who are blocked from your organization](/articles/viewing-users-who-are-blocked-from-your-organization)"
|
||||
- "[Blocking a user from your personal account](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-personal-account)"
|
||||
- "[Unblocking a user from your personal account](/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-personal-account)"
|
||||
- "[Viewing users who are blocked from your organization](/communities/maintaining-your-safety-on-github/viewing-users-who-are-blocked-from-your-organization)"
|
||||
@@ -0,0 +1,23 @@
|
||||
---
|
||||
title: Moderating comments and conversations
|
||||
shortTitle: Moderation
|
||||
intro: 'Moderating conversations creates a welcoming community for all contributors to your project by promoting healthy collaboration and de-escalating conflict. You can apply your community''s code of conduct to discussions by viewing reported content, editing and deleting comments, and locking conversations.'
|
||||
redirect_from:
|
||||
- /articles/moderating-comments-and-conversations
|
||||
- /github/building-a-strong-community/moderating-comments-and-conversations
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- community
|
||||
---
|
||||
|
||||
{% link_in_list /managing-disruptive-comments %}
|
||||
{% link_in_list /locking-conversations %}
|
||||
{% link_in_list /limiting-interactions-in-your-repository %}
|
||||
{% link_in_list /limiting-interactions-for-your-user-account %}
|
||||
{% link_in_list /limiting-interactions-in-your-organization %}
|
||||
{% link_in_list /tracking-changes-in-a-comment %}
|
||||
{% link_in_list /managing-how-contributors-report-abuse-in-your-organizations-repository %}
|
||||
{% link_in_list /managing-reported-content-in-your-organizations-repository %}
|
||||
@@ -4,6 +4,8 @@ intro: You can temporarily enforce a period of limited activity for certain user
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
permissions: Anyone can limit interactions for their own user account.
|
||||
redirect_from:
|
||||
- /github/building-a-strong-community/limiting-interactions-for-your-user-account
|
||||
topics:
|
||||
- community
|
||||
---
|
||||
@@ -16,9 +18,9 @@ Limiting interactions for your user account enables temporary interaction limits
|
||||
|
||||
{% data reusables.community.types-of-interaction-limits %}
|
||||
|
||||
When you enable user-wide activity limitations, you can't enable or disable interaction limits on individual repositories. For more information on limiting activity for an individual repository, see "[Limiting interactions in your repository](/articles/limiting-interactions-in-your-repository)."
|
||||
When you enable user-wide activity limitations, you can't enable or disable interaction limits on individual repositories. For more information on limiting activity for an individual repository, see "[Limiting interactions in your repository](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)."
|
||||
|
||||
You can also block users. For more information, see "[Blocking a user from your personal account](/github/building-a-strong-community/blocking-a-user-from-your-personal-account)."
|
||||
You can also block users. For more information, see "[Blocking a user from your personal account](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-personal-account)."
|
||||
|
||||
### Limiting interactions for your user account
|
||||
|
||||
@@ -4,6 +4,7 @@ intro: You can temporarily enforce a period of limited activity for certain user
|
||||
redirect_from:
|
||||
- /github/setting-up-and-managing-organizations-and-teams/limiting-interactions-in-your-organization
|
||||
- /articles/limiting-interactions-in-your-organization
|
||||
- /github/building-a-strong-community/limiting-interactions-in-your-organization
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
permissions: Organization owners can limit interactions in an organization.
|
||||
@@ -21,9 +22,9 @@ Limiting interactions in your organization enables temporary interaction limits
|
||||
|
||||
Members of the organization are not affected by any of the limit types.
|
||||
|
||||
When you enable organization-wide activity limitations, you can't enable or disable interaction limits on individual repositories. For more information on limiting activity for an individual repository, see "[Limiting interactions in your repository](/articles/limiting-interactions-in-your-repository)."
|
||||
When you enable organization-wide activity limitations, you can't enable or disable interaction limits on individual repositories. For more information on limiting activity for an individual repository, see "[Limiting interactions in your repository](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)."
|
||||
|
||||
Organization owners can also block users for a specific amount of time. After the block expires, the user is automatically unblocked. For more information, see "[Blocking a user from your organization](/articles/blocking-a-user-from-your-organization)."
|
||||
Organization owners can also block users for a specific amount of time. After the block expires, the user is automatically unblocked. For more information, see "[Blocking a user from your organization](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)."
|
||||
|
||||
### Limiting interactions in your organization
|
||||
|
||||
@@ -38,7 +39,7 @@ Organization owners can also block users for a specific amount of time. After th
|
||||

|
||||
|
||||
### Further reading
|
||||
- "[Reporting abuse or spam](/articles/reporting-abuse-or-spam)"
|
||||
- "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)"
|
||||
- "[Managing an individual's access to an organization repository](/articles/managing-an-individual-s-access-to-an-organization-repository)"
|
||||
- "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository)"
|
||||
- "[Repository permission levels for an organization](/articles/repository-permission-levels-for-an-organization)"
|
||||
@@ -4,6 +4,7 @@ intro: You can temporarily enforce a period of limited activity for certain user
|
||||
redirect_from:
|
||||
- /articles/limiting-interactions-with-your-repository/
|
||||
- /articles/limiting-interactions-in-your-repository
|
||||
- /github/building-a-strong-community/limiting-interactions-in-your-repository
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
permissions: People with admin permissions to a repository can temporarily limit interactions in that repository.
|
||||
@@ -19,7 +20,7 @@ topics:
|
||||
|
||||
{% data reusables.community.types-of-interaction-limits %}
|
||||
|
||||
You can also enable activity limitations on all repositories owned by your user account or an organization. If a user-wide or organization-wide limit is enabled, you can't limit activity for individual repositories owned by the account. For more information, see "[Limiting interactions for your user account](/github/building-a-strong-community/limiting-interactions-for-your-user-account)" and "[Limiting interactions in your organization](/github/building-a-strong-community/limiting-interactions-in-your-organization)."
|
||||
You can also enable activity limitations on all repositories owned by your user account or an organization. If a user-wide or organization-wide limit is enabled, you can't limit activity for individual repositories owned by the account. For more information, see "[Limiting interactions for your user account](/communities/moderating-comments-and-conversations/limiting-interactions-for-your-user-account)" and "[Limiting interactions in your organization](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization)."
|
||||
|
||||
### Limiting interactions in your repository
|
||||
|
||||
@@ -33,7 +34,7 @@ You can also enable activity limitations on all repositories owned by your user
|
||||

|
||||
|
||||
### Further reading
|
||||
- "[Reporting abuse or spam](/articles/reporting-abuse-or-spam)"
|
||||
- "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)"
|
||||
- "[Managing an individual's access to an organization repository](/articles/managing-an-individual-s-access-to-an-organization-repository)"
|
||||
- "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository)"
|
||||
- "[Repository permission levels for an organization](/articles/repository-permission-levels-for-an-organization)"
|
||||
@@ -3,6 +3,7 @@ title: Locking conversations
|
||||
intro: 'Repository owners and collaborators, and people with write access to a repository, can lock conversations on issues, pull requests, and commits permanently or temporarily to defuse a heated interaction.'
|
||||
redirect_from:
|
||||
- /articles/locking-conversations
|
||||
- /github/building-a-strong-community/locking-conversations
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -33,10 +34,10 @@ To search for locked conversations in a repository that is not archived, you can
|
||||
|
||||
### Further reading
|
||||
|
||||
- "[Setting up your project for healthy contributions](/articles/setting-up-your-project-for-healthy-contributions)"
|
||||
- "[Using templates to encourage useful issues and pull requests](/github/building-a-strong-community/using-templates-to-encourage-useful-issues-and-pull-requests)"
|
||||
- "[Managing disruptive comments](/articles/managing-disruptive-comments)"{% if currentVersion == "free-pro-team@latest" %}
|
||||
- "[Maintaining your safety on {% data variables.product.prodname_dotcom %}](/github/building-a-strong-community/maintaining-your-safety-on-github)"
|
||||
- "[Reporting abuse or spam](/articles/reporting-abuse-or-spam)"
|
||||
- "[Limiting interactions in your repository](/github/building-a-strong-community/limiting-interactions-in-your-repository)"
|
||||
- "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)"
|
||||
- "[Using templates to encourage useful issues and pull requests](/communities/using-templates-to-encourage-useful-issues-and-pull-requests)"
|
||||
- "[Managing disruptive comments](/communities/moderating-comments-and-conversations/managing-disruptive-comments)"{% if currentVersion == "free-pro-team@latest" %}
|
||||
- "[Maintaining your safety on {% data variables.product.prodname_dotcom %}](/communities/maintaining-your-safety-on-github)"
|
||||
- "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)"
|
||||
- "[Limiting interactions in your repository](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)"
|
||||
{% endif %}
|
||||
@@ -5,6 +5,7 @@ redirect_from:
|
||||
- /articles/editing-a-comment/
|
||||
- /articles/deleting-a-comment/
|
||||
- /articles/managing-disruptive-comments
|
||||
- /github/building-a-strong-community/managing-disruptive-comments
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -53,7 +54,7 @@ Anyone with read access to a repository can view a comment's edit history. The *
|
||||
|
||||

|
||||
|
||||
Comment authors and anyone with write access to a repository can also delete sensitive information from a comment's edit history. For more information, see "[Tracking changes in a comment](/github/building-a-strong-community/tracking-changes-in-a-comment)."
|
||||
Comment authors and anyone with write access to a repository can also delete sensitive information from a comment's edit history. For more information, see "[Tracking changes in a comment](/communities/moderating-comments-and-conversations/tracking-changes-in-a-comment)."
|
||||
|
||||
1. Navigate to the comment you'd like to edit.
|
||||
2. In the upper-right corner of the comment, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **Edit**.
|
||||
@@ -3,6 +3,8 @@ title: Managing how contributors report abuse in your organization's repository
|
||||
intro: You can allow contributors to report disruptive behavior directly to repository maintainers.
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
redirect_from:
|
||||
- /github/building-a-strong-community/managing-how-contributors-report-abuse-in-your-organizations-repository
|
||||
topics:
|
||||
- community
|
||||
---
|
||||
@@ -19,6 +21,6 @@ You can enable or disable reported content for public repositories owned by an o
|
||||
|
||||
### Further reading
|
||||
|
||||
- "[Managing reported content in your organization's repository](/github/building-a-strong-community/managing-reported-content-in-your-organizations-repository)"
|
||||
- "[Moderating comments and conversations](/github/building-a-strong-community/moderating-comments-and-conversations)"
|
||||
- "[About community management and moderation](/github/building-a-strong-community/about-community-management-and-moderation)"
|
||||
- "[Managing reported content in your organization's repository](/communities/moderating-comments-and-conversations/managing-reported-content-in-your-organizations-repository)"
|
||||
- "[Moderating comments and conversations](/communities/moderating-comments-and-conversations)"
|
||||
- "[About community management and moderation](/communities/setting-up-your-project-for-healthy-contributions/about-community-management-and-moderation)"
|
||||
@@ -3,6 +3,8 @@ title: Managing reported content in your organization's repository
|
||||
intro: 'After a contributor reports disruptive content in a repository, repository maintainers can view and manage the report.'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
redirect_from:
|
||||
- /github/building-a-strong-community/managing-reported-content-in-your-organizations-repository
|
||||
topics:
|
||||
- community
|
||||
---
|
||||
@@ -11,7 +13,7 @@ Anyone with admin permissions to a repository can view and manage reported conte
|
||||
|
||||
### About management of reported content
|
||||
|
||||
Before you can view or manage reported content, you must enable reported content for the repository. For more information, see "[Managing how contributors report abuse in your organization's repository](/github/building-a-strong-community/managing-how-contributors-report-abuse-in-your-organizations-repository)."
|
||||
Before you can view or manage reported content, you must enable reported content for the repository. For more information, see "[Managing how contributors report abuse in your organization's repository](/communities/moderating-comments-and-conversations/managing-how-contributors-report-abuse-in-your-organizations-repository)."
|
||||
|
||||
You can track, triage, and respond to reports of disruptive content. In the "Abuse reports" list, you can view all reports and navigate directly to each reported comment on {% data variables.product.prodname_dotcom %}.
|
||||
|
||||
@@ -46,4 +48,4 @@ After you finish moderating disruptive content, you can mark the report as resol
|
||||
|
||||
### Further reading
|
||||
|
||||
- "[About community management and moderation](/github/building-a-strong-community/about-community-management-and-moderation)"
|
||||
- "[About community management and moderation](/communities/setting-up-your-project-for-healthy-contributions/about-community-management-and-moderation)"
|
||||
@@ -3,6 +3,7 @@ title: Tracking changes in a comment
|
||||
intro: You can view the edit history of a comment or delete sensitive information from the edit history of a comment.
|
||||
redirect_from:
|
||||
- /articles/tracking-changes-in-a-comment
|
||||
- /github/building-a-strong-community/tracking-changes-in-a-comment
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -32,5 +33,5 @@ When you delete sensitive information from the comment's edit history, the perso
|
||||
|
||||
### Further reading
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}- "[Reporting abuse or spam](/articles/reporting-abuse-or-spam)"{% endif %}
|
||||
{% if currentVersion == "free-pro-team@latest" %}- "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)"{% endif %}
|
||||
- "[Editing a comment](/articles/editing-a-comment)"
|
||||
@@ -3,6 +3,8 @@ title: About community management and moderation
|
||||
intro: '{% data variables.product.prodname_dotcom %} offers tools that help repository maintainers establish and enforce standards of behavior in their communities on {% data variables.product.prodname_dotcom_the_website %}.'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
redirect_from:
|
||||
- /github/building-a-strong-community/about-community-management-and-moderation
|
||||
topics:
|
||||
- community
|
||||
---
|
||||
@@ -19,11 +21,11 @@ After you establish standards of behavior for your community, you can encourage
|
||||
|
||||
{% data variables.product.prodname_dotcom %}'s tools streamline management and moderation tasks in your community without requiring extensive moderation experience.
|
||||
|
||||
As a repository maintainer, you can author guidelines for contributing to your project and share them in the project's repository. {% data variables.product.prodname_dotcom %} offers a community profile checklist to help you author and publish community health files. Potential contributors to your project can review the community profile checklist to learn about your community's standards and decide whether they want to contribute. For more information, see "[Setting up your project for healthy contributions](/github/building-a-strong-community/setting-up-your-project-for-healthy-contributions)."
|
||||
As a repository maintainer, you can author guidelines for contributing to your project and share them in the project's repository. {% data variables.product.prodname_dotcom %} offers a community profile checklist to help you author and publish community health files. Potential contributors to your project can review the community profile checklist to learn about your community's standards and decide whether they want to contribute. For more information, see "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)."
|
||||
|
||||
{% data reusables.community.tools-for-moderating %}
|
||||
|
||||
Contributors can always report disruptive content to {% data variables.contact.github_support %}. If you opt into reported content for a public repository in your organization, contributors can also report comments containing disruptive behavior directly to repository maintainers. For more information, see "[Managing reported content in your organization's repository](/github/building-a-strong-community/managing-reported-content-in-your-organizations-repository)."
|
||||
Contributors can always report disruptive content to {% data variables.contact.github_support %}. If you opt into reported content for a public repository in your organization, contributors can also report comments containing disruptive behavior directly to repository maintainers. For more information, see "[Managing reported content in your organization's repository](/communities/moderating-comments-and-conversations/managing-reported-content-in-your-organizations-repository)."
|
||||
|
||||
### Further reading
|
||||
|
||||
@@ -4,6 +4,7 @@ intro: Repository maintainers can review their public repository's community pro
|
||||
redirect_from:
|
||||
- /articles/viewing-your-community-profile/
|
||||
- /articles/about-community-profiles-for-public-repositories
|
||||
- /github/building-a-strong-community/about-community-profiles-for-public-repositories
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
@@ -4,6 +4,7 @@ intro: View a public repository's community profile to check on a project's heal
|
||||
redirect_from:
|
||||
- /articles/accessing-a-project-s-community-profile
|
||||
- /articles/accessing-a-projects-community-profile
|
||||
- /github/building-a-strong-community/accessing-a-projects-community-profile
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
@@ -3,6 +3,7 @@ title: Adding a code of conduct to your project
|
||||
intro: 'Adopt a code of conduct to define community standards, signal a welcoming and inclusive project, and outline procedures for handling abuse.'
|
||||
redirect_from:
|
||||
- /articles/adding-a-code-of-conduct-to-your-project
|
||||
- /github/building-a-strong-community/adding-a-code-of-conduct-to-your-project
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
@@ -16,9 +17,9 @@ Before adopting a code of conduct for your project:
|
||||
* Research different codes of conduct designed for open source projects. Choose one that reflects your community's standards.
|
||||
* Consider carefully whether you are willing and able to enforce it.
|
||||
|
||||
You can add a code of conduct to your project by using a template or manually creating a custom code of conduct. Your code of conduct will be available either way, but "Code of conduct" will only be marked as complete in your repository's community profile if you use a template. If you use a code of conduct written by another person or organization, be sure to follow any attribution guidelines from the source. For more information about community profiles, see "[About community profiles for public repositories](/github/building-a-strong-community/about-community-profiles-for-public-repositories)."
|
||||
You can add a code of conduct to your project by using a template or manually creating a custom code of conduct. Your code of conduct will be available either way, but "Code of conduct" will only be marked as complete in your repository's community profile if you use a template. If you use a code of conduct written by another person or organization, be sure to follow any attribution guidelines from the source. For more information about community profiles, see "[About community profiles for public repositories](//communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)."
|
||||
|
||||
You can create a default code of conduct for your organization or user account. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file)."
|
||||
You can create a default code of conduct for your organization or user account. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)."
|
||||
|
||||
### Adding a code of conduct using a template
|
||||
|
||||
@@ -3,6 +3,7 @@ title: Adding a license to a repository
|
||||
intro: You can include an open source license in your repository to make it easier for other people to contribute.
|
||||
redirect_from:
|
||||
- /articles/adding-a-license-to-a-repository
|
||||
- /github/building-a-strong-community/adding-a-license-to-a-repository
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -3,6 +3,7 @@ title: Adding support resources to your project
|
||||
intro: You can create a SUPPORT file to let people know about ways to get help with your project.
|
||||
redirect_from:
|
||||
- /articles/adding-support-resources-to-your-project
|
||||
- /github/building-a-strong-community/adding-support-resources-to-your-project
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -16,7 +17,7 @@ To direct people to specific support resources, you can add a SUPPORT file to yo
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
|
||||
You can create default support resources for your organization or user account. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file)."
|
||||
You can create default support resources for your organization or user account. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -4,6 +4,7 @@ intro: 'You can create default community health files, such as CONTRIBUTING and
|
||||
redirect_from:
|
||||
- /articles/creating-a-default-community-health-file-for-your-organization
|
||||
- /github/building-a-strong-community/creating-a-default-community-health-file-for-your-organization
|
||||
- /github/building-a-strong-community/creating-a-default-community-health-file
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -4,6 +4,7 @@ intro: Apply the `good first issue` label to issues in your repository to highli
|
||||
redirect_from:
|
||||
- /github/building-a-strong-community/helping-new-contributors-find-your-project-with-labels
|
||||
- /articles/helping-new-contributors-find-your-project-with-labels
|
||||
- /github/building-a-strong-community/encouraging-helpful-contributions-to-your-project-with-labels
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
@@ -0,0 +1,25 @@
|
||||
---
|
||||
title: Setting up your project for healthy contributions
|
||||
shortTitle: Healthy contributions
|
||||
intro: 'Repository maintainers can set contributing guidelines to help collaborators make meaningful, useful contributions to a project.'
|
||||
redirect_from:
|
||||
- /articles/helping-people-contribute-to-your-project/
|
||||
- /articles/setting-up-your-project-for-healthy-contributions
|
||||
- /github/building-a-strong-community/setting-up-your-project-for-healthy-contributions
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- community
|
||||
---
|
||||
|
||||
{% link_in_list /about-community-management-and-moderation %}
|
||||
{% link_in_list /about-community-profiles-for-public-repositories %}
|
||||
{% link_in_list /accessing-a-projects-community-profile %}
|
||||
{% link_in_list /adding-a-code-of-conduct-to-your-project %}
|
||||
{% link_in_list /setting-guidelines-for-repository-contributors %}
|
||||
{% link_in_list /adding-a-license-to-a-repository %}
|
||||
{% link_in_list /adding-support-resources-to-your-project %}
|
||||
{% link_in_list /creating-a-default-community-health-file %}
|
||||
{% link_in_list /encouraging-helpful-contributions-to-your-project-with-labels %}
|
||||
@@ -1,13 +1,14 @@
|
||||
---
|
||||
title: Setting guidelines for repository contributors
|
||||
redirect_from:
|
||||
- /articles/how-do-i-set-up-guidelines-for-contributors/
|
||||
- /articles/setting-guidelines-for-repository-contributors
|
||||
intro: You can create guidelines to communicate how people should contribute to your project.
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
redirect_from:
|
||||
- /articles/how-do-i-set-up-guidelines-for-contributors/
|
||||
- /articles/setting-guidelines-for-repository-contributors
|
||||
- /github/building-a-strong-community/setting-guidelines-for-repository-contributors
|
||||
topics:
|
||||
- community
|
||||
---
|
||||
@@ -24,7 +25,7 @@ For both owners and contributors, contribution guidelines save time and hassle c
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
|
||||
You can create default contribution guidelines for your organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %}. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file)."
|
||||
You can create default contribution guidelines for your organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %}. For more information, see "[Creating a default community health file](//communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -3,6 +3,7 @@ title: About issue and pull request templates
|
||||
intro: 'With issue and pull request templates, you can customize and standardize the information you''d like contributors to include when they open issues and pull requests in your repository.'
|
||||
redirect_from:
|
||||
- /articles/about-issue-and-pull-request-templates
|
||||
- /github/building-a-strong-community/about-issue-and-pull-request-templates
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -15,7 +16,7 @@ After you create issue and pull request templates in your repository, contributo
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
|
||||
You can create default issue and pull request templates for your organization or user account. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file)."
|
||||
You can create default issue and pull request templates for your organization or user account. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -28,7 +29,7 @@ When you create issue templates for your repository using the issue template bui
|
||||
Using the template builder, you can specify a title and description for each template, add the template content, and either commit the template to the default branch or open a pull request in the repository. The template builder automatically adds the YAML front matter markup that is required for the template to show on the new issue page. For more information, see "[Configuring issue templates for your repository](/articles/configuring-issue-templates-for-your-repository)."
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
|
||||
{% data reusables.repositories.issue-template-config %} For more information, see "[Configuring issue templates for your repository](/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser)."
|
||||
{% data reusables.repositories.issue-template-config %} For more information, see "[Configuring issue templates for your repository](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser)."
|
||||
{% endif %}
|
||||
|
||||
Issue templates are stored on the repository's default branch, in a hidden `.github/ISSUE_TEMPLATE` directory. If you create a template in another branch, it will not be available for collaborators to use. Issue template filenames are not case sensitive, and need a *.md* extension. {% data reusables.repositories.valid-community-issues %}
|
||||
@@ -4,6 +4,7 @@ intro: You can customize the templates that are available for contributors to us
|
||||
redirect_from:
|
||||
- /github/building-a-strong-community/creating-issue-templates-for-your-repository
|
||||
- /articles/configuring-issue-templates-for-your-repository
|
||||
- /github/building-a-strong-community/configuring-issue-templates-for-your-repository
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -3,6 +3,7 @@ title: Creating a pull request template for your repository
|
||||
intro: 'When you add a pull request template to your repository, project contributors will automatically see the template''s contents in the pull request body.'
|
||||
redirect_from:
|
||||
- /articles/creating-a-pull-request-template-for-your-repository
|
||||
- /github/building-a-strong-community/creating-a-pull-request-template-for-your-repository
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -17,7 +18,7 @@ You can create a *PULL_REQUEST_TEMPLATE/* subdirectory in any of the supported f
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
|
||||
You can create default pull request templates for your organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %}. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file)."
|
||||
You can create default pull request templates for your organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %}. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -1,11 +1,12 @@
|
||||
---
|
||||
title: Using templates to encourage useful issues and pull requests
|
||||
shortTitle: Issue & PR templates
|
||||
intro: Repository maintainers can add templates in a repository to help contributors create high-quality issues and pull requests.
|
||||
mapTopic: true
|
||||
redirect_from:
|
||||
- /github/building-a-strong-community/using-issue-and-pull-request-templates
|
||||
- /articles/using-templates-to-encourage-high-quality-issues-and-pull-requests-in-your-repository/
|
||||
- /articles/using-issue-and-pull-request-templates
|
||||
- /github/building-a-strong-community/using-templates-to-encourage-useful-issues-and-pull-requests
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -14,3 +15,7 @@ topics:
|
||||
- community
|
||||
---
|
||||
|
||||
{% link_in_list /about-issue-and-pull-request-templates %}
|
||||
{% link_in_list /configuring-issue-templates-for-your-repository %}
|
||||
{% link_in_list /creating-a-pull-request-template-for-your-repository %}
|
||||
{% link_in_list /manually-creating-a-single-issue-template-for-your-repository %}
|
||||
@@ -4,6 +4,7 @@ intro: 'When you add a manually-created issue template to your repository, proje
|
||||
redirect_from:
|
||||
- /articles/creating-an-issue-template-for-your-repository/
|
||||
- /articles/manually-creating-a-single-issue-template-for-your-repository
|
||||
- /github/building-a-strong-community/manually-creating-a-single-issue-template-for-your-repository
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -16,6 +16,7 @@ versions:
|
||||
### 1. Choosing a branch and making changes
|
||||
|
||||
1. [Create a new branch](/desktop/guides/contributing-to-projects/managing-branches), or select an existing branch by clicking {% octicon "git-branch" aria-label="The branch icon" %} **Current Branch** on the toolbar and selecting the branch from the list.
|
||||
|
||||

|
||||
{% data reusables.desktop.make-changes %}
|
||||
|
||||
@@ -27,10 +28,13 @@ As you make changes to files in your text editor and save them locally, you will
|
||||
* The yellow {% octicon "diff-modified" aria-label="The diff modified icon color-yellow" %} icon indicates modified files.
|
||||
* The green {% octicon "diff-added" aria-label="The diff added icon color-green" %} icon indicates added files.
|
||||
* To access stashed changes, click **Stashed Changes**.
|
||||

|
||||
|
||||

|
||||
* {% data reusables.desktop.commit-all-desc %}
|
||||
|
||||

|
||||
* {% data reusables.desktop.commit-some-desc %}
|
||||
|
||||

|
||||
|
||||
#### Creating a partial commit
|
||||
@@ -44,8 +48,10 @@ If one file contains multiple changes, but you only want some of those changes t
|
||||
{% endnote %}
|
||||
|
||||
1. To choose how your changes are displayed, in the top-right corner of the changed file, use {% octicon "gear" aria-label="The Gear icon" %} to select **Unified** or **Split**.
|
||||
|
||||

|
||||
2. To exclude changed lines from your commit, click one or more changed lines so the blue disappears. The lines that are still highlighted in blue will be included in the commit.
|
||||
|
||||

|
||||
|
||||
### 3. Discarding changes
|
||||
@@ -57,8 +63,10 @@ Discarded changes are saved in a dated file in the Trash. You can recover discar
|
||||
|
||||
{% data reusables.desktop.select-discard-files %}
|
||||
{% data reusables.desktop.click-discard-files %}
|
||||
|
||||

|
||||
{% data reusables.desktop.confirm-discard-files %}
|
||||
|
||||

|
||||
|
||||
#### Discarding changes in one or more lines
|
||||
@@ -90,15 +98,19 @@ Once you're satisfied with the changes you've chosen to include in your commit,
|
||||
{% endnote %}
|
||||
|
||||
{% data reusables.desktop.commit-message %}
|
||||
|
||||

|
||||
2. Optionally, to attribute a commit to another author, click the add co-authors icon and type the username(s) you want to include.
|
||||
|
||||

|
||||
{% data reusables.desktop.commit-button %}
|
||||
|
||||

|
||||
4. If the branch you're trying to commit to is protected, Desktop will warn you.
|
||||
- To move your changes, click **switch branches**.
|
||||
- To commit your changes to the protected branch, click **Commit to _BRANCH_**.
|
||||
|
||||
For more information about protected branches, see "[About protected branches](/github/administering-a-repository/about-protected-branches)".
|
||||
|
||||

|
||||
{% data reusables.desktop.push-origin %}
|
||||
|
||||
@@ -16,7 +16,7 @@ topics:
|
||||
|
||||
You can add query parameters to these URLs to preselect the configuration of a {% data variables.product.prodname_github_app %} on a personal or organization account:
|
||||
* **User account:** `{% data variables.product.oauth_host_code %}/settings/apps/new`
|
||||
* **Organization account:** `{% data variables.product.oauth_host_code %}/:org/settings/apps/new`
|
||||
* **Organization account:** `{% data variables.product.oauth_host_code %}/organizations/:org/settings/apps/new`
|
||||
|
||||
The person creating the app can edit the preselected values from the {% data variables.product.prodname_github_app %} registration page, before submitting the app. If you do not include required parameters in the URL query string, like `name`, the person creating the app will need to input a value before submitting the app.
|
||||
|
||||
|
||||
@@ -724,7 +724,7 @@ Someone unsubscribed from receiving notifications for an issue or pull request.
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
### user_blocked
|
||||
|
||||
An organization owner blocked a user from the organization. This was done [through one of the blocked user's comments on the issue](/articles/blocking-a-user-from-your-organization#blocking-a-user-in-a-comment).
|
||||
An organization owner blocked a user from the organization. This was done [through one of the blocked user's comments on the issue](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization#blocking-a-user-in-a-comment).
|
||||
|
||||
#### Availability
|
||||
|
||||
|
||||
@@ -50,5 +50,5 @@ You can share your feedback about {% data variables.product.prodname_discussions
|
||||
- "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/github/writing-on-github/about-writing-and-formatting-on-github)"
|
||||
- "[Searching discussions](/github/searching-for-information-on-github/searching-discussions)"
|
||||
- "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications)"
|
||||
- "[Moderating comments and conversations](/github/building-a-strong-community/moderating-comments-and-conversations)"
|
||||
- "[Maintaining your safety on {% data variables.product.prodname_dotcom %}](/github/building-a-strong-community/maintaining-your-safety-on-github)"
|
||||
- "[Moderating comments and conversations](/communities/moderating-comments-and-conversations)"
|
||||
- "[Maintaining your safety on {% data variables.product.prodname_dotcom %}](/communities/maintaining-your-safety-on-github)"
|
||||
|
||||
@@ -47,4 +47,4 @@ You can search for discussions and filter the list of discussions in a repositor
|
||||
### Further reading
|
||||
|
||||
- "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/github/writing-on-github/about-writing-and-formatting-on-github)"
|
||||
- "[Maintaining your safety on {% data variables.product.prodname_dotcom %}](/github/building-a-strong-community/maintaining-your-safety-on-github)"
|
||||
- "[Maintaining your safety on {% data variables.product.prodname_dotcom %}](/communities/maintaining-your-safety-on-github)"
|
||||
|
||||
@@ -14,7 +14,7 @@ versions:
|
||||
|
||||
In addition to starting or viewing a discussion, you can comment in response to the original comment from the author of the discussion. You can also create a comment thread by replying to an individual comment that another community member made within the discussion, and react to comments with emoji. For more information about reactions, see "[About conversations on {% data variables.product.prodname_dotcom %}](/github/collaborating-with-issues-and-pull-requests/about-conversations-on-github#reacting-to-ideas-in-comments)."
|
||||
|
||||
You can block users and report disruptive content to maintain a safe and pleasant environment for yourself on {% data variables.product.product_name %}. For more information, see "[Maintaining your safety on {% data variables.product.prodname_dotcom %}](/github/building-a-strong-community/maintaining-your-safety-on-github)."
|
||||
You can block users and report disruptive content to maintain a safe and pleasant environment for yourself on {% data variables.product.product_name %}. For more information, see "[Maintaining your safety on {% data variables.product.prodname_dotcom %}](/communities/maintaining-your-safety-on-github)."
|
||||
|
||||
### Prerequisites
|
||||
|
||||
|
||||
@@ -35,7 +35,7 @@ Issues are useful for discussing specific details of a project such as bug repor
|
||||
|
||||
Before you open a discussion, check to see if the repository has contributing guidelines. The CONTRIBUTING file includes information about how the repository maintainer would like you to contribute ideas to the project.
|
||||
|
||||
For more information, see "[Setting up your project for healthy contributions](/github/building-a-strong-community/setting-up-your-project-for-healthy-contributions)."
|
||||
For more information, see "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)."
|
||||
|
||||
### Next steps
|
||||
|
||||
@@ -43,7 +43,7 @@ To continue learning about {% data variables.product.prodname_discussions %} and
|
||||
|
||||
### Further reading
|
||||
|
||||
- "[Setting up your project for healthy contributions](/articles/setting-up-your-project-for-healthy-contributions)"
|
||||
- "[Using templates to encourage useful issues and pull requests](/github/building-a-strong-community/using-templates-to-encourage-useful-issues-and-pull-requests)"
|
||||
- "[Moderating comments and conversations](/articles/moderating-comments-and-conversations)"
|
||||
- "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)"
|
||||
- "[Using templates to encourage useful issues and pull requests](/communities/using-templates-to-encourage-useful-issues-and-pull-requests)"
|
||||
- "[Moderating comments and conversations](/communities/moderating-comments-and-conversations)"
|
||||
- "[Writing on {% data variables.product.prodname_dotcom %}](/articles/writing-on-github)"
|
||||
|
||||
@@ -14,9 +14,9 @@ versions:
|
||||
|
||||
Organization owners can choose the permissions required to create a discussion for repositories owned by the organization. For more information, see "[Managing discussion creation for repositories in your organization](/github/setting-up-and-managing-organizations-and-teams/managing-discussion-creation-for-repositories-in-your-organization)."
|
||||
|
||||
As a discussions maintainer, you can create community resources to encourage discussions that are aligned with the overall project goal and maintain a friendly open forum for collaborators. Creating a code of conduct or contribution guidelines for collaborators to follow will help facilitate a collaborative and productive forum. For more information on creating community resources, see "[Adding a code of conduct to your project](/github/building-a-strong-community/adding-a-code-of-conduct-to-your-project)," and "[Setting guidelines for repository contributors](/github/building-a-strong-community/setting-guidelines-for-repository-contributors)."
|
||||
As a discussions maintainer, you can create community resources to encourage discussions that are aligned with the overall project goal and maintain a friendly open forum for collaborators. Creating a code of conduct or contribution guidelines for collaborators to follow will help facilitate a collaborative and productive forum. For more information on creating community resources, see "[Adding a code of conduct to your project](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)," and "[Setting guidelines for repository contributors](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)."
|
||||
|
||||
For more information on facilitating a healthy discussion, see "[Moderating comments and conversations](/github/building-a-strong-community/moderating-comments-and-conversations)."
|
||||
For more information on facilitating a healthy discussion, see "[Moderating comments and conversations](/communities/moderating-comments-and-conversations)."
|
||||
|
||||
### Prerequisites
|
||||
|
||||
|
||||
@@ -39,7 +39,7 @@ You can welcome your community and introduce a new way to communicate in a repos
|
||||
|
||||
You can set contributing guidelines to encourage collaborators to have meaningful, useful conversations that are relevant to the repository. You can also update the repository's README to communicate expectations on when collaborators should open an issue or discussion.
|
||||
|
||||
For more information about providing guidelines for your project, see "[Adding a code of conduct to your project](/github/building-a-strong-community/adding-a-code-of-conduct-to-your-project)" and "[Setting up your project for healthy contributions](/github/building-a-strong-community/setting-up-your-project-for-healthy-contributions)."
|
||||
For more information about providing guidelines for your project, see "[Adding a code of conduct to your project](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)" and "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)."
|
||||
|
||||
### Creating a new discussion
|
||||
|
||||
|
||||
@@ -54,7 +54,7 @@ custom: ["https://www.paypal.me/octocat", octocat.com]
|
||||
|
||||
{% endnote %}
|
||||
|
||||
You can create a default sponsor button for your organization or user account. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file)."
|
||||
You can create a default sponsor button for your organization or user account. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)."
|
||||
|
||||
{% note %}
|
||||
|
||||
|
||||
@@ -254,7 +254,7 @@ An overview of some of the most common actions that are recorded as events in th
|
||||
| `failed_login` | Triggered when you failed to log in successfully.
|
||||
| `remove_email` | Triggered when you remove an email address.
|
||||
| `rename` | Triggered when you rename your account.{% if currentVersion == "free-pro-team@latest" %}
|
||||
| `report_content` | Triggered when you [report an issue or pull request, or a comment on an issue, pull request, or commit](/articles/reporting-abuse-or-spam).{% endif %}
|
||||
| `report_content` | Triggered when you [report an issue or pull request, or a comment on an issue, pull request, or commit](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam).{% endif %}
|
||||
| `show_private_contributions_count` | Triggered when you [publicize private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile).{% if currentVersion != "github-ae@latest" %}
|
||||
| `two_factor_requested` | Triggered when {% data variables.product.product_name %} asks you for [your two-factor authentication code](/articles/accessing-github-using-two-factor-authentication).{% endif %}
|
||||
|
||||
|
||||
@@ -1,17 +0,0 @@
|
||||
---
|
||||
title: Documenting your project with wikis
|
||||
intro: 'You can use a wiki to share detailed, long-form information about your project.'
|
||||
redirect_from:
|
||||
- /categories/49/articles/
|
||||
- /categories/wiki/
|
||||
- /articles/documenting-your-project-with-wikis
|
||||
product: '{% data reusables.gated-features.wikis %}'
|
||||
mapTopic: true
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- community
|
||||
---
|
||||
|
||||
@@ -1,56 +0,0 @@
|
||||
---
|
||||
title: Building a strong community
|
||||
intro: 'Whether your project is open source or private, you can build a healthy and effective environment for collaboration.'
|
||||
redirect_from:
|
||||
- /categories/building-a-strong-community
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- community
|
||||
---
|
||||
|
||||
|
||||
### Table of Contents
|
||||
|
||||
{% topic_link_in_list /setting-up-your-project-for-healthy-contributions %}
|
||||
{% link_in_list /about-community-management-and-moderation %}
|
||||
{% link_in_list /about-community-profiles-for-public-repositories %}
|
||||
{% link_in_list /accessing-a-projects-community-profile %}
|
||||
{% link_in_list /adding-a-code-of-conduct-to-your-project %}
|
||||
{% link_in_list /setting-guidelines-for-repository-contributors %}
|
||||
{% link_in_list /adding-a-license-to-a-repository %}
|
||||
{% link_in_list /adding-support-resources-to-your-project %}
|
||||
{% link_in_list /creating-a-default-community-health-file %}
|
||||
{% link_in_list /encouraging-helpful-contributions-to-your-project-with-labels %}
|
||||
{% topic_link_in_list /using-templates-to-encourage-useful-issues-and-pull-requests %}
|
||||
{% link_in_list /about-issue-and-pull-request-templates %}
|
||||
{% link_in_list /configuring-issue-templates-for-your-repository %}
|
||||
{% link_in_list /creating-a-pull-request-template-for-your-repository %}
|
||||
{% link_in_list /manually-creating-a-single-issue-template-for-your-repository %}
|
||||
{% topic_link_in_list /moderating-comments-and-conversations %}
|
||||
{% link_in_list /managing-disruptive-comments %}
|
||||
{% link_in_list /locking-conversations %}
|
||||
{% link_in_list /limiting-interactions-in-your-repository %}
|
||||
{% link_in_list /limiting-interactions-for-your-user-account %}
|
||||
{% link_in_list /limiting-interactions-in-your-organization %}
|
||||
{% link_in_list /tracking-changes-in-a-comment %}
|
||||
{% link_in_list /managing-how-contributors-report-abuse-in-your-organizations-repository %}
|
||||
{% link_in_list /managing-reported-content-in-your-organizations-repository %}
|
||||
{% topic_link_in_list /maintaining-your-safety-on-github %}
|
||||
{% link_in_list /blocking-a-user-from-your-personal-account %}
|
||||
{% link_in_list /viewing-users-youve-blocked-from-your-personal-account %}
|
||||
{% link_in_list /unblocking-a-user-from-your-personal-account %}
|
||||
{% link_in_list /blocking-a-user-from-your-organization %}
|
||||
{% link_in_list /viewing-users-who-are-blocked-from-your-organization %}
|
||||
{% link_in_list /unblocking-a-user-from-your-organization %}
|
||||
{% link_in_list /reporting-abuse-or-spam %}
|
||||
{% topic_link_in_list /documenting-your-project-with-wikis %}
|
||||
{% link_in_list /about-wikis %}
|
||||
{% link_in_list /adding-or-editing-wiki-pages %}
|
||||
{% link_in_list /creating-a-footer-or-sidebar-for-your-wiki %}
|
||||
{% link_in_list /editing-wiki-content %}
|
||||
{% link_in_list /viewing-a-wikis-history-of-changes %}
|
||||
{% link_in_list /changing-access-permissions-for-wikis %}
|
||||
{% link_in_list /disabling-wikis %}
|
||||
@@ -1,14 +0,0 @@
|
||||
---
|
||||
title: Moderating comments and conversations
|
||||
intro: 'Moderating conversations creates a welcoming community for all contributors to your project by promoting healthy collaboration and de-escalating conflict. You can apply your community''s code of conduct to discussions by viewing reported content, editing and deleting comments, and locking conversations.'
|
||||
mapTopic: true
|
||||
redirect_from:
|
||||
- /articles/moderating-comments-and-conversations
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- community
|
||||
---
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
---
|
||||
title: Setting up your project for healthy contributions
|
||||
intro: 'Repository maintainers can set contributing guidelines to help collaborators make meaningful, useful contributions to a project.'
|
||||
redirect_from:
|
||||
- /articles/helping-people-contribute-to-your-project/
|
||||
- /articles/setting-up-your-project-for-healthy-contributions
|
||||
mapTopic: true
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- community
|
||||
---
|
||||
|
||||
@@ -43,7 +43,7 @@ Similar to contributing guidelines, the repository maintainer may have included
|
||||
|
||||
### Further reading
|
||||
|
||||
- "[Setting up your project for healthy contributions](/articles/setting-up-your-project-for-healthy-contributions)"
|
||||
- "[Using templates to encourage useful issues and pull requests](/github/building-a-strong-community/using-templates-to-encourage-useful-issues-and-pull-requests)"
|
||||
- "[Moderating comments and conversations](/articles/moderating-comments-and-conversations)"
|
||||
- "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)"
|
||||
- "[Using templates to encourage useful issues and pull requests](/communities/using-templates-to-encourage-useful-issues-and-pull-requests)"
|
||||
- "[Moderating comments and conversations](/communities/moderating-comments-and-conversations)"
|
||||
- "[Writing on {% data variables.product.prodname_dotcom %}](/articles/writing-on-github)"
|
||||
|
||||
@@ -58,5 +58,5 @@ Anyone watching the pull request or repository will receive a notification of yo
|
||||
### Further reading
|
||||
|
||||
- "[Creating a permanent link to a code snippet](/articles/creating-a-permanent-link-to-a-code-snippet/)"
|
||||
{% if currentVersion == "free-pro-team@latest" %}- "[Reporting abuse or spam](/articles/reporting-abuse-or-spam)"
|
||||
{% if currentVersion == "free-pro-team@latest" %}- "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)"
|
||||
{% endif %}
|
||||
|
||||
@@ -17,7 +17,7 @@ topics:
|
||||
|
||||
You can add a README file to a repository to communicate important information about your project. A README, along with a repository license{% if currentVersion == "free-pro-team@latest" %}, contribution guidelines, and a code of conduct{% elsif enterpriseServerVersions contains currentVersion %} and contribution guidelines{% endif %}, communicates expectations for your project and helps you manage contributions.
|
||||
|
||||
For more information about providing guidelines for your project, see {% if currentVersion == "free-pro-team@latest" %}"[Adding a code of conduct to your project](/github/building-a-strong-community/adding-a-code-of-conduct-to-your-project)" and {% endif %}"[Setting up your project for healthy contributions](/github/building-a-strong-community/setting-up-your-project-for-healthy-contributions)."
|
||||
For more information about providing guidelines for your project, see {% if currentVersion == "free-pro-team@latest" %}"[Adding a code of conduct to your project](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)" and {% endif %}"[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)."
|
||||
|
||||
A README is often the first item a visitor will see when visiting your repository. README files typically include information on:
|
||||
- What the project does
|
||||
|
||||
@@ -38,5 +38,5 @@ You can use repositories to manage your work and collaborate with others.
|
||||
- "[Managing your work on {% data variables.product.prodname_dotcom %}](/categories/managing-your-work-on-github/)"
|
||||
- "[Administering a repository](/categories/administering-a-repository)"
|
||||
- "[Visualizing repository data with graphs](/categories/visualizing-repository-data-with-graphs/)"
|
||||
- "[About wikis](/articles/about-wikis)"
|
||||
- "[About wikis](/communities/documenting-your-project-with-wikis/about-wikis)"
|
||||
- "[{% data variables.product.prodname_dotcom %} glossary](/articles/github-glossary)"
|
||||
|
||||
@@ -18,7 +18,7 @@ To download an archive of your repository, you can use the API for user or organ
|
||||
You can download and back up your repositories manually:
|
||||
|
||||
- To download a repository's Git data to your local machine, you'll need to clone the repository. For more information, see "[Cloning a repository](/articles/cloning-a-repository)."
|
||||
- You can also download your repository's wiki. For more information, see "[Adding or editing wiki pages](/articles/adding-or-editing-wiki-pages)."
|
||||
- You can also download your repository's wiki. For more information, see "[Adding or editing wiki pages](/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages)."
|
||||
|
||||
When you clone a repository or wiki, only Git data, such as project files and commit history, is downloaded. You can use our API to export other elements of your {% data variables.product.product_name %} repository to your local machine:
|
||||
|
||||
|
||||
@@ -36,7 +36,7 @@ Below is a list of some of the available keyboard shortcuts.
|
||||
|<kbd>g</kbd> <kbd>p</kbd> | Go to the **Pull requests** tab. For more information, see "[About pull requests](/articles/about-pull-requests)."{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
|
||||
|<kbd>g</kbd> <kbd>a</kbd> | Go to the **Actions** tab. For more information, see "[About Actions](/actions/getting-started-with-github-actions/about-github-actions)."{% endif %}
|
||||
|<kbd>g</kbd> <kbd>b</kbd> | Go to the **Projects** tab. For more information, see "[About project boards](/articles/about-project-boards)."
|
||||
|<kbd>g</kbd> <kbd>w</kbd> | Go to the **Wiki** tab. For more information, see "[About wikis](/articles/about-wikis)."
|
||||
|<kbd>g</kbd> <kbd>w</kbd> | Go to the **Wiki** tab. For more information, see "[About wikis](/communities/documenting-your-project-with-wikis/about-wikis)."
|
||||
|
||||
### Source code editing
|
||||
|
||||
|
||||
@@ -38,8 +38,6 @@ versions:
|
||||
{% link_in_list /managing-your-work-on-github %}
|
||||
{% link_in_list /developing-online-with-codespaces %}
|
||||
|
||||
{% link_in_list /building-a-strong-community %}
|
||||
|
||||
{% link_in_list /searching-for-information-on-github %}
|
||||
|
||||
{% link_in_list /importing-your-projects-to-github %}
|
||||
|
||||
@@ -14,7 +14,7 @@ If collaborators on your repository don't have {% data variables.large_files.pro
|
||||
|
||||
{% tip %}
|
||||
|
||||
**Tip:** To help users without {% data variables.large_files.product_name_short %} enabled, we recommend you set guidelines for repository contributors that describe how to work with large files. For example, you may ask contributors not to modify large files, or to upload changes to a file sharing service like [Dropbox](http://www.dropbox.com/) or <a href="https://drive.google.com/" data-proofer-ignore>Google Drive</a>. For more information, see "[Setting guidelines for repository contributors](/github/building-a-strong-community/setting-guidelines-for-repository-contributors)."
|
||||
**Tip:** To help users without {% data variables.large_files.product_name_short %} enabled, we recommend you set guidelines for repository contributors that describe how to work with large files. For example, you may ask contributors not to modify large files, or to upload changes to a file sharing service like [Dropbox](http://www.dropbox.com/) or <a href="https://drive.google.com/" data-proofer-ignore>Google Drive</a>. For more information, see "[Setting guidelines for repository contributors](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)."
|
||||
|
||||
{% endtip %}
|
||||
|
||||
|
||||
@@ -131,7 +131,7 @@ Email notifications from {% data variables.product.product_name %} contain the f
|
||||
| --- | --- |
|
||||
| `From` address | This address will always be {% if currentVersion == "free-pro-team@latest" %}'`notifications@github.com`'{% else %}'the no-reply email address configured by your site administrator'{% endif %}. |
|
||||
| `To` field | This field connects directly to the thread.{% if currentVersion != "github-ae@latest" %} If you reply to the email, you'll add a new comment to the conversation.{% endif %} |
|
||||
| `Cc` address | {% data variables.product.product_name %} will `Cc` you if you're subscribed to a conversation. The second `Cc` email address matches the notification reason. The suffix for these notification reasons is {% data variables.notifications.cc_address %}. The possible notification reasons are: <ul><li>`assign`: You were assigned to an issue or pull request.</li><li>`author`: You created an issue or pull request.</li><li>`comment`: You commented on an issue or pull request.</li><li>`manual`: There was an update to an issue or pull request you manually subscribed to.</li><li>`mention`: You were mentioned on an issue or pull request.</li><li>`push`: Someone committed to a pull request you're subscribed to.</li><li>`review_requested`: You or a team you're a member of was requested to review a pull request.</li>{% if currentVersion != "github-ae@latest" %}<li>`security_alert`: {% data variables.product.prodname_dotcom %} detected a vulnerability in a repository you receive alerts for.</li>{% endif %}<li>`state_change`: An issue or pull request you're subscribed to was either closed or opened.</li><li>`subscribed`: There was an update in a repository you're watching.</li><li>`team_mention`: A team you belong to was mentioned on an issue or pull request.</li><li>`your_activity`: You opened, commented on, or closed an issue or pull request.</li></ul> |
|
||||
| `Cc` address | {% data variables.product.product_name %} will `Cc` you if you're subscribed to a conversation. The second `Cc` email address matches the notification reason. The suffix for these notification reasons is {% data variables.notifications.cc_address %}. The possible notification reasons are: <ul><li>`assign`: You were assigned to an issue or pull request.</li><li>`author`: You created an issue or pull request.</li>{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}<li>`ci_activity`: A {% data variables.product.prodname_actions %} workflow run that you triggered was completed.</li>{% endif %}<li>`comment`: You commented on an issue or pull request.</li><li>`manual`: There was an update to an issue or pull request you manually subscribed to.</li><li>`mention`: You were mentioned on an issue or pull request.</li><li>`push`: Someone committed to a pull request you're subscribed to.</li><li>`review_requested`: You or a team you're a member of was requested to review a pull request.</li>{% if currentVersion != "github-ae@latest" %}<li>`security_alert`: {% data variables.product.prodname_dotcom %} detected a vulnerability in a repository you receive alerts for.</li>{% endif %}<li>`state_change`: An issue or pull request you're subscribed to was either closed or opened.</li><li>`subscribed`: There was an update in a repository you're watching.</li><li>`team_mention`: A team you belong to was mentioned on an issue or pull request.</li><li>`your_activity`: You opened, commented on, or closed an issue or pull request.</li></ul> |
|
||||
| `mailing list` field | This field identifies the name of the repository and its owner. The format of this address is always `<repository name>.<repository owner>.{% data variables.command_line.backticks %}`. |{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
|
||||
| `X-GitHub-Severity` field | {% data reusables.repositories.security-alerts-x-github-severity %} The possible severity levels are:<ul><li>`low`</li><li>`moderate`</li><li>`high`</li><li>`critical`</li></ul>For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." |{% endif %}
|
||||
|
||||
|
||||
@@ -37,6 +37,6 @@ With issues, you can:
|
||||
- Transfer open issues to other repositories. For more information, see "[Transferring an issue to another repository](/articles/transferring-an-issue-to-another-repository)."
|
||||
- Pin important issues to make them easier to find, preventing duplicate issues and reducing noise. For more information, see "[Pinning an issue to your repository](/articles/pinning-an-issue-to-your-repository)."
|
||||
- Track duplicate issues using saved replies. For more information, see "[About saved replies](/articles/about-saved-replies)."{% if currentVersion == "free-pro-team@latest" %}
|
||||
- Report comments that violate {% data variables.product.prodname_dotcom %}'s [Community Guidelines](/articles/github-community-guidelines). For more information, see "[Reporting abuse or spam](/articles/reporting-abuse-or-spam)."{% endif %}
|
||||
- Report comments that violate {% data variables.product.prodname_dotcom %}'s [Community Guidelines](/articles/github-community-guidelines). For more information, see "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)."{% endif %}
|
||||
|
||||
Issues can also be [assigned to other users](/articles/assigning-issues-and-pull-requests-to-other-github-users), [tagged with labels](/articles/applying-labels-to-issues-and-pull-requests) for quicker searching, and [grouped together with milestones](/articles/creating-and-editing-milestones-for-issues-and-pull-requests).
|
||||
|
||||
@@ -29,7 +29,7 @@ If you're using a project board to track and prioritize your work, you can conve
|
||||
{% tip %}
|
||||
|
||||
**Tips**: Project maintainers can choose to:
|
||||
- Create an issue template for a repository. Templates include prompts for information in the body of an issue. For more information, see "[About issue and pull request templates](/github/building-a-strong-community/about-issue-and-pull-request-templates)."
|
||||
- Create an issue template for a repository. Templates include prompts for information in the body of an issue. For more information, see "[About issue and pull request templates](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)."
|
||||
- Disable issues for a repository. For more information, see "[Disabling issues](/github/managing-your-work-on-github/disabling-issues)." Pull requests can't be turned off and are always available.
|
||||
|
||||
{% endtip %}
|
||||
|
||||
@@ -96,4 +96,4 @@ Deleting a label will remove the label from issues and pull requests.
|
||||
### Further reading
|
||||
- "[Filtering issues and pull requests by labels](/articles/filtering-issues-and-pull-requests-by-labels)"{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
- "[Managing default labels for repositories in your organization](/articles/managing-default-labels-for-repositories-in-your-organization)"{% endif %}{% if currentVersion == "free-pro-team@latest" %}
|
||||
- "[Encouraging helpful contributions to your project with labels](/github/building-a-strong-community/encouraging-helpful-contributions-to-your-project-with-labels)"{% endif %}
|
||||
- "[Encouraging helpful contributions to your project with labels](/communities/setting-up-your-project-for-healthy-contributions/encouraging-helpful-contributions-to-your-project-with-labels)"{% endif %}
|
||||
|
||||
@@ -176,7 +176,7 @@ You can search repositories based on whether or not the repositories are archive
|
||||
|
||||
### Search based on number of issues with `good first issue` or `help wanted` labels
|
||||
|
||||
You can search for repositories that have a minimum number of issues labeled `help-wanted` or `good-first-issue` with the qualifiers `help-wanted-issues:>n` and `good-first-issues:>n`. For more information, see "[Encouraging helpful contributions to your project with labels](/github/building-a-strong-community/encouraging-helpful-contributions-to-your-project-with-labels)."
|
||||
You can search for repositories that have a minimum number of issues labeled `help-wanted` or `good-first-issue` with the qualifiers `help-wanted-issues:>n` and `good-first-issues:>n`. For more information, see "[Encouraging helpful contributions to your project with labels](/communities/setting-up-your-project-for-healthy-contributions/encouraging-helpful-contributions-to-your-project-with-labels)."
|
||||
|
||||
| Qualifier | Example
|
||||
| ------------- | -------------
|
||||
|
||||
@@ -312,7 +312,7 @@ The `archived` qualifier filters your results based on whether an issue or pull
|
||||
|
||||
### Search based on whether a conversation is locked
|
||||
|
||||
You can search for an issue or pull request that has a locked conversation using the `is` qualifier. For more information, see "[Locking conversations](/articles/locking-conversations)."
|
||||
You can search for an issue or pull request that has a locked conversation using the `is` qualifier. For more information, see "[Locking conversations](/communities/moderating-comments-and-conversations/locking-conversations)."
|
||||
|
||||
| Qualifier | Example
|
||||
| ------------- | -------------
|
||||
|
||||
@@ -54,8 +54,8 @@ Organization members can have *owner*{% if currentVersion == "free-pro-team@late
|
||||
| View organization insights (see "[Viewing insights for your organization](/articles/viewing-insights-for-your-organization)" for details) | **X** | **X** | |
|
||||
| View and post public team discussions to **all teams** (see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)" for details) | **X** | **X** | |
|
||||
| View and post private team discussions to **all teams** (see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)" for details) | **X** | | |
|
||||
| Edit and delete team discussions in **all teams** (see "[Managing disruptive comments](/articles/managing-disruptive-comments)" for details) | **X** | | |
|
||||
| Hide comments on commits, pull requests, and issues (see "[Managing disruptive comments](/articles/managing-disruptive-comments/#hiding-a-comment)" for details) | **X** | **X** | |
|
||||
| Edit and delete team discussions in **all teams** (see "[Managing disruptive comments](/communities/moderating-comments-and-conversations/managing-disruptive-comments)" for details) | **X** | | |
|
||||
| Hide comments on commits, pull requests, and issues (see "[Managing disruptive comments](/communities/moderating-comments-and-conversations/managing-disruptive-comments/#hiding-a-comment)" for details) | **X** | **X** | |
|
||||
| Disable team discussions for an organization (see "[Disabling team discussions for your organization](/articles/disabling-team-discussions-for-your-organization)" for details) | **X** | | |
|
||||
| Manage viewing of organization dependency insights (see "[Changing the visibility of your organization's dependency insights](/articles/changing-the-visibility-of-your-organizations-dependency-insights)" for details) | **X** | | |
|
||||
| Set a team profile picture in **all teams** (see "[Setting your team's profile picture](/articles/setting-your-team-s-profile-picture)" for details) | **X** | | |
|
||||
@@ -73,7 +73,7 @@ Organization members can have *owner*{% if currentVersion == "free-pro-team@late
|
||||
| Receive [{% data variables.product.prodname_dependabot_alerts %} about vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies) for all of an organization's repositories | **X** | | |
|
||||
| Manage {% data variables.product.prodname_dependabot_security_updates %} (see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)") | **X** | | |
|
||||
| [Manage the forking policy](/github/setting-up-and-managing-organizations-and-teams/managing-the-forking-policy-for-your-organization) | **X** | | |
|
||||
| [Limit activity in public repositories in an organization](/articles/limiting-interactions-in-your-organization) | **X** | | |
|
||||
| [Limit activity in public repositories in an organization](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization) | **X** | | |
|
||||
| Pull (read), push (write), and clone (copy) *all repositories* in the organization | **X** | | |
|
||||
| Convert organization members to [outside collaborators](#outside-collaborators) | **X** | | |
|
||||
| [View people with access to an organization repository](/articles/viewing-people-with-access-to-your-repository) | **X** | | |
|
||||
@@ -108,8 +108,8 @@ Organization members can have *owner*{% if currentVersion == "free-pro-team@late
|
||||
| Create project boards (see "[Project board permissions for an organization](/articles/project-board-permissions-for-an-organization)" for details) | **X** | **X** | |
|
||||
| View and post public team discussions to **all teams** (see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)" for details) | **X** | **X** | |
|
||||
| View and post private team discussions to **all teams** (see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)" for details) | **X** | | |
|
||||
| Edit and delete team discussions in **all teams** (for more information, see "[Managing disruptive comments](/articles/managing-disruptive-comments)) | **X** | | |
|
||||
| Hide comments on commits, pull requests, and issues (see "[Managing disruptive comments](/articles/managing-disruptive-comments/#hiding-a-comment)" for details) | **X** | **X** | **X** |
|
||||
| Edit and delete team discussions in **all teams** (for more information, see "[Managing disruptive comments](/communities/moderating-comments-and-conversations/managing-disruptive-comments)) | **X** | | |
|
||||
| Hide comments on commits, pull requests, and issues (see "[Managing disruptive comments](/communities/moderating-comments-and-conversations/managing-disruptive-comments/#hiding-a-comment)" for details) | **X** | **X** | **X** |
|
||||
| Disable team discussions for an organization (see "[Disabling team discussions for your organization](/articles/disabling-team-discussions-for-your-organization)" for details) | **X** | | |
|
||||
| Set a team profile picture in **all teams** (see "[Setting your team's profile picture](/articles/setting-your-team-s-profile-picture)" for details) | **X** | | |{% if currentVersion ver_gt "enterprise-server@3.0" %}
|
||||
| Manage the publication of {% data variables.product.prodname_pages %} sites from repositories in the organization (see "[Managing the publication of {% data variables.product.prodname_pages %} sites for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-the-publication-of-github-pages-sites-for-your-organization)" for details) | **X** | |{% endif %}
|
||||
|
||||
@@ -68,7 +68,7 @@ In addition to managing organization-level settings, organization owners have ad
|
||||
| View published releases | **X** | **X** | **X** | **X** | **X** |{% if currentVersion == "free-pro-team@latest" %}
|
||||
| View [GitHub Actions workflow runs](/actions/automating-your-workflow-with-github-actions/managing-a-workflow-run) | **X** | **X** | **X** | **X** | **X** |{% endif %}
|
||||
| Edit wikis | **X** | **X** | **X** | **X** | **X** |{% if currentVersion == "free-pro-team@latest" %}
|
||||
| [Report abusive or spammy content](/articles/reporting-abuse-or-spam) | **X** | **X** | **X** | **X** | **X** |{% endif %}
|
||||
| [Report abusive or spammy content](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam) | **X** | **X** | **X** | **X** | **X** |{% endif %}
|
||||
| Apply/dismiss labels | | **X** | **X** | **X** | **X** |
|
||||
| Create, edit, delete labels | | | **X** | **X** | **X** |
|
||||
| Close, reopen, and assign all issues and pull requests | | **X** | **X** | **X** | **X** |{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
|
||||
@@ -78,8 +78,8 @@ In addition to managing organization-level settings, organization owners have ad
|
||||
| Request [pull request reviews](/articles/requesting-a-pull-request-review) | | **X** | **X** | **X** | **X** |
|
||||
| Push to (write) the person or team's assigned repositories | | | **X** | **X** | **X** |
|
||||
| Edit and delete anyone's comments on commits, pull requests, and issues | | | **X** | **X** | **X** |
|
||||
| [Hide anyone's comments](/articles/managing-disruptive-comments) | | | **X** | **X** | **X** |
|
||||
| [Lock conversations](/articles/locking-conversations) | | | **X** | **X** | **X** |
|
||||
| [Hide anyone's comments](/communities/moderating-comments-and-conversations/managing-disruptive-comments) | | | **X** | **X** | **X** |
|
||||
| [Lock conversations](/communities/moderating-comments-and-conversations/locking-conversations) | | | **X** | **X** | **X** |
|
||||
| Transfer issues (see "[Transferring an issue to another repository](/articles/transferring-an-issue-to-another-repository)" for details) | | | **X** | **X** | **X** |
|
||||
| [Act as a designated code owner for a repository](/articles/about-code-owners) | | | **X** | **X** | **X** |
|
||||
| [Mark a draft pull request as ready for review](/articles/changing-the-stage-of-a-pull-request) | | | **X** | **X** | **X** |{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
|
||||
@@ -101,7 +101,7 @@ In addition to managing organization-level settings, organization owners have ad
|
||||
| Configure [a publishing source for {% data variables.product.prodname_pages %}](/articles/configuring-a-publishing-source-for-github-pages) | | | | **X** | **X** |
|
||||
| [Push to protected branches](/articles/about-protected-branches) | | | | **X** | **X** |
|
||||
| [Create and edit repository social cards](/articles/customizing-your-repositorys-social-media-preview) | | | | **X** | **X** |{% if currentVersion == "free-pro-team@latest" %}
|
||||
| Limit [interactions in a repository](/github/building-a-strong-community/limiting-interactions-in-your-repository)| | | | **X** | **X** |{% endif %}
|
||||
| Limit [interactions in a repository](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)| | | | **X** | **X** |{% endif %}
|
||||
| Delete an issue (see "[Deleting an issue](/articles/deleting-an-issue)") | | | | | **X** |
|
||||
| Merge pull requests on protected branches, even if there are no approving reviews | | | | | **X** |
|
||||
| [Define code owners for a repository](/articles/about-code-owners) | | | | | **X** |
|
||||
|
||||
@@ -348,7 +348,7 @@ For more information, see "[Managing the publication of {% data variables.produc
|
||||
| `advanced_security_policy_selected_member_disabled` | Triggered when an enterprise owner prevents {% data variables.product.prodname_GH_advanced_security %} features from being enabled for repositories owned by the organization. {% data reusables.advanced-security.more-information-about-enforcement-policy %}
|
||||
| `advanced_security_policy_selected_member_enabled` | Triggered when an enterprise owner allows {% data variables.product.prodname_GH_advanced_security %} features to be enabled for repositories owned by the organization. {% data reusables.advanced-security.more-information-about-enforcement-policy %}{% endif %}{% if currentVersion == "free-pro-team@latest" %}
|
||||
| `audit_log_export` | Triggered when an organization admin [creates an export of the organization audit log](#exporting-the-audit-log). If the export included a query, the log will list the query used and the number of audit log entries matching that query.
|
||||
| `block_user` | Triggered when an organization owner [blocks a user from accessing the organization's repositories](/articles/blocking-a-user-from-your-organization).
|
||||
| `block_user` | Triggered when an organization owner [blocks a user from accessing the organization's repositories](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).
|
||||
| `cancel_invitation` | Triggered when an organization invitation has been revoked. {% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
|
||||
| `create_actions_secret` | Triggered when a {% data variables.product.prodname_actions %} secret is created for an organization. For more information, see "[Creating encrypted secrets for an organization](/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-an-organization)."{% endif %} {% if currentVersion == "free-pro-team@latest"%}
|
||||
| `disable_oauth_app_restrictions` | Triggered when an owner [disables {% data variables.product.prodname_oauth_app %} access restrictions](/articles/disabling-oauth-app-access-restrictions-for-your-organization) for your organization.
|
||||
@@ -378,7 +378,7 @@ For more information, see "[Managing the publication of {% data variables.produc
|
||||
| `runner_group_runner_removed` | Triggered when the REST API is used to remove a self-hosted runner from a group. For more information, see "[Remove a self-hosted runner from a group for an organization](/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization)."
|
||||
| `runner_group_runners_updated`| Triggered when a runner group's list of members is updated. For more information, see "[Set self-hosted runners in a group for an organization](/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization)."{% endif %}{% if currentVersion == "free-pro-team@latest"%}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
|
||||
| `self_hosted_runner_updated` | Triggered when the runner application is updated. Can be viewed using the REST API and the UI; not visible in the JSON/CSV export. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)."{% endif %}
|
||||
| `unblock_user` | Triggered when an organization owner [unblocks a user from an organization](/articles/unblocking-a-user-from-your-organization).{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
|
||||
| `unblock_user` | Triggered when an organization owner [unblocks a user from an organization](/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization).{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
|
||||
| `update_actions_secret` |Triggered when a {% data variables.product.prodname_actions %} secret is updated.{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
|
||||
| `update_new_repository_default_branch_setting` | Triggered when an owner changes the name of the default branch for new repositories in the organization. For more information, see "[Managing the default branch name for repositories in your organization](/github/setting-up-and-managing-organizations-and-teams/managing-the-default-branch-name-for-repositories-in-your-organization)."{% endif %}
|
||||
| `update_default_repository_permission` | Triggered when an owner changes the default repository permission level for organization members.
|
||||
|
||||
@@ -31,7 +31,7 @@ The repository owner has full control of the repository. In addition to the acti
|
||||
| :- | :- |
|
||||
| {% if currentVersion == "free-pro-team@latest" %}Invite collaborators{% else %}Add collaborators{% endif %} | "[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository)" |
|
||||
| Change the visibility of the repository | "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)" |{% if currentVersion == "free-pro-team@latest" %}
|
||||
| Limit interactions with the repository | "[Limiting interactions in your repository](/github/building-a-strong-community/limiting-interactions-in-your-repository)" |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
|
||||
| Limit interactions with the repository | "[Limiting interactions in your repository](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)" |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
|
||||
| Rename a branch, including the default branch | "[Renaming a branch](/github/administering-a-repository/renaming-a-branch)" |{% endif %}
|
||||
| Merge a pull request on a protected branch, even if there are no approving reviews | "[About protected branches](/github/administering-a-repository/about-protected-branches)" |
|
||||
| Delete the repository | "[Deleting a repository](/github/administering-a-repository/deleting-a-repository)" |
|
||||
@@ -67,7 +67,7 @@ Collaborators can also perform the following actions.
|
||||
| :- | :- |
|
||||
| Fork the repository | "[About forks](/github/collaborating-with-issues-and-pull-requests/about-forks)" |{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
|
||||
| Rename a branch other than the default branch | "[Renaming a branch](/github/administering-a-repository/renaming-a-branch)" |{% endif %}
|
||||
| Create, edit, and delete comments on commits, pull requests, and issues in the repository | <ul><li>"[About issues](/github/managing-your-work-on-github/about-issues)"</li><li>"[Commenting on a pull request](/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request)"</li><li>"[Managing disruptive comments](/github/building-a-strong-community/managing-disruptive-comments)"</li></ul> |
|
||||
| Create, edit, and delete comments on commits, pull requests, and issues in the repository | <ul><li>"[About issues](/github/managing-your-work-on-github/about-issues)"</li><li>"[Commenting on a pull request](/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request)"</li><li>"[Managing disruptive comments](/communities/moderating-comments-and-conversations/managing-disruptive-comments)"</li></ul> |
|
||||
| Create, assign, close, and re-open issues in the repository | "[Managing your work with issues](/github/managing-your-work-on-github/managing-your-work-with-issues)" |
|
||||
| Manage labels for issues and pull requests in the repository | "[Labeling issues and pull requests](/github/managing-your-work-on-github/labeling-issues-and-pull-requests)" |
|
||||
| Manage milestones for issues and pull requests in the repository | "[Creating and editing milestones for issues and pull requests](/github/managing-your-work-on-github/creating-and-editing-milestones-for-issues-and-pull-requests)" |
|
||||
@@ -77,7 +77,7 @@ Collaborators can also perform the following actions.
|
||||
| Apply suggested changes to pull requests in the repository |"[Incorporating feedback in your pull request](/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request)" |
|
||||
| Create a pull request from a fork of the repository | "[Creating a pull request from a fork](/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)" |
|
||||
| Submit a review on a pull request that affects the mergeability of the pull request | "[Reviewing proposed changes in a pull request](/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request)" |
|
||||
| Create and edit a wiki for the repository | "[About wikis](/github/building-a-strong-community/about-wikis)" |
|
||||
| Create and edit a wiki for the repository | "[About wikis](/communities/documenting-your-project-with-wikis/about-wikis)" |
|
||||
| Create and edit releases for the repository | "[Managing releases in a repository](/github/administering-a-repository/managing-releases-in-a-repository)" |
|
||||
| Act as a code owner for the repository | "[About code owners](/articles/about-code-owners)" |{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" %}
|
||||
| Publish, view, or install packages | "[Publishing and managing packages](/github/managing-packages-with-github-packages/publishing-and-managing-packages)" |{% endif %}
|
||||
|
||||
@@ -30,7 +30,7 @@ You can authenticate to {% data variables.product.prodname_registry %} with Apac
|
||||
|
||||
In the `servers` tag, add a child `server` tag with an `id`, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, and *TOKEN* with your personal access token.
|
||||
|
||||
In the `repositories` tag, configure a repository by mapping the `id` of the repository to the `id` you added in the `server` tag containing your credentials. Replace {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}*HOSTNAME* with the host name of {% data variables.product.product_location %}, {% endif %}*REPOSITORY* with the name of the repository you'd like to publish a package to or install a package from, and *OWNER* with the name of the user or organization account that owns the repository. Because uppercase letters aren't supported, you must use lowercase letters for the repository owner even if the {% data variables.product.prodname_dotcom %} user or organization name contains uppercase letters.
|
||||
In the `repositories` tag, configure a repository by mapping the `id` of the repository to the `id` you added in the `server` tag containing your credentials. Replace {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}*HOSTNAME* with the host name of {% data variables.product.product_location %}, {% endif %}, and *OWNER* with the name of the user or organization account that owns the repository. Because uppercase letters aren't supported, you must use lowercase letters for the repository owner even if the {% data variables.product.prodname_dotcom %} user or organization name contains uppercase letters.
|
||||
|
||||
If you want to interact with multiple repositories, you can add each repository to separate `repository` children in the `repositories` tag, mapping the `id` of each to the credentials in the `servers` tag.
|
||||
|
||||
@@ -134,10 +134,9 @@ If you would like to publish multiple packages to the same repository, you can i
|
||||
|
||||
For more information on creating a package, see the [maven.apache.org documentation](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html).
|
||||
|
||||
1. Edit the `distributionManagement` element of the *pom.xml* file located in your package directory, replacing {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}*HOSTNAME* with the host name of {% data variables.product.product_location %}, {% endif %}`OWNER` with the name of the user or organization account that owns the repository and `REPOSITORY` with the name of the repository containing your project.
|
||||
{% if enterpriseServerVersions contains currentVersion %}
|
||||
If your instance has subdomain isolation enabled:
|
||||
{% endif %}
|
||||
1. Edit the `distributionManagement` element of the *pom.xml* file located in your package directory, replacing {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}*HOSTNAME* with the host name of {% data variables.product.product_location %}, {% endif %}`OWNER` with the name of the user or organization account that owns the repository and `REPOSITORY` with the name of the repository containing your project.{% if enterpriseServerVersions contains currentVersion %}
|
||||
|
||||
If your instance has subdomain isolation enabled:{% endif %}
|
||||
```xml
|
||||
<distributionManagement>
|
||||
<repository>
|
||||
@@ -146,8 +145,7 @@ For more information on creating a package, see the [maven.apache.org documentat
|
||||
<url>https://{% if currentVersion == "free-pro-team@latest" %}maven.pkg.github.com{% else %}maven.HOSTNAME{% endif %}/OWNER/REPOSITORY</url>
|
||||
</repository>
|
||||
</distributionManagement>
|
||||
```
|
||||
{% if enterpriseServerVersions contains currentVersion %}
|
||||
```{% if enterpriseServerVersions contains currentVersion %}
|
||||
If your instance has subdomain isolation disabled:
|
||||
```xml
|
||||
<distributionManagement>
|
||||
@@ -157,10 +155,9 @@ For more information on creating a package, see the [maven.apache.org documentat
|
||||
<url>https://HOSTNAME/_registry/maven/OWNER/REPOSITORY</url>
|
||||
</repository>
|
||||
</distributionManagement>
|
||||
```
|
||||
{% endif %}
|
||||
2. Publish the package.
|
||||
|
||||
```{% endif %}
|
||||
{% data reusables.package_registry.checksum-maven-plugin %}
|
||||
1. Publish the package.
|
||||
```shell
|
||||
$ mvn deploy
|
||||
```
|
||||
@@ -183,6 +180,7 @@ To install an Apache Maven package from {% data variables.product.prodname_regis
|
||||
</dependency>
|
||||
</dependencies>
|
||||
```
|
||||
{% data reusables.package_registry.checksum-maven-plugin %}
|
||||
3. Install the package.
|
||||
|
||||
```shell
|
||||
|
||||
@@ -80,5 +80,6 @@ module.exports = [
|
||||
'sso',
|
||||
'teams',
|
||||
'usernames',
|
||||
'webhooks'
|
||||
'webhooks',
|
||||
'Xcode'
|
||||
]
|
||||
|
||||
@@ -3129,7 +3129,9 @@ type Commit implements GitObject & Node & Subscribable & UniformResourceLocatabl
|
||||
additions: Int!
|
||||
|
||||
"""
|
||||
The pull requests associated with a commit
|
||||
The merged Pull Request that introduced the commit to the repository. If the
|
||||
commit is not present in the default branch, additionally returns open Pull
|
||||
Requests associated with the commit
|
||||
"""
|
||||
associatedPullRequests(
|
||||
"""
|
||||
@@ -31492,6 +31494,11 @@ type Sponsorship implements Node {
|
||||
createdAt: DateTime!
|
||||
id: ID!
|
||||
|
||||
"""
|
||||
Whether this sponsorship represents a one-time payment versus a recurring sponsorship.
|
||||
"""
|
||||
isOneTimePayment: Boolean!
|
||||
|
||||
"""
|
||||
The entity that is being sponsored
|
||||
"""
|
||||
|
||||
@@ -3219,7 +3219,9 @@ type Commit implements GitObject & Node & Subscribable & UniformResourceLocatabl
|
||||
additions: Int!
|
||||
|
||||
"""
|
||||
The pull requests associated with a commit
|
||||
The merged Pull Request that introduced the commit to the repository. If the
|
||||
commit is not present in the default branch, additionally returns open Pull
|
||||
Requests associated with the commit
|
||||
"""
|
||||
associatedPullRequests(
|
||||
"""
|
||||
@@ -34242,6 +34244,13 @@ type SponsorsTier implements Node {
|
||||
"""
|
||||
adminInfo: SponsorsTierAdminInfo
|
||||
|
||||
"""
|
||||
Get a different tier for this tier's maintainer that is at the same frequency
|
||||
as this tier but with a lesser cost. Returns the published tier with the
|
||||
monthly price closest to this tier's without going over.
|
||||
"""
|
||||
closestLesserValueTier: SponsorsTier
|
||||
|
||||
"""
|
||||
Identifies the date and time when the object was created.
|
||||
"""
|
||||
@@ -34258,6 +34267,12 @@ type SponsorsTier implements Node {
|
||||
descriptionHTML: HTML!
|
||||
id: ID!
|
||||
|
||||
"""
|
||||
Whether this tier was chosen at checkout time by the sponsor rather than
|
||||
defined ahead of time by the maintainer who manages the Sponsors listing.
|
||||
"""
|
||||
isCustomAmount: Boolean!
|
||||
|
||||
"""
|
||||
Whether this tier is only for use with one-time sponsorships.
|
||||
"""
|
||||
@@ -34410,6 +34425,11 @@ type Sponsorship implements Node {
|
||||
createdAt: DateTime!
|
||||
id: ID!
|
||||
|
||||
"""
|
||||
Whether this sponsorship represents a one-time payment versus a recurring sponsorship.
|
||||
"""
|
||||
isOneTimePayment: Boolean!
|
||||
|
||||
"""
|
||||
The entity that is being sponsored
|
||||
"""
|
||||
|
||||
@@ -12,5 +12,6 @@ productsInOrder:
|
||||
- rest
|
||||
- graphql
|
||||
- insights
|
||||
- communities
|
||||
- education
|
||||
- desktop
|
||||
|
||||
@@ -126,7 +126,7 @@ sections:
|
||||
- Users can dismiss a mandatory message without checking all checkboxes.
|
||||
- '[Pre-receive hook scripts](/admin/policies/enforcing-policy-with-pre-receive-hooks) cannot write temporary files, which may cause script execution to fail. Users who use pre-receive hooks should test in a staging environment to see if scripts require write access.'
|
||||
- Repository [deploy keys](/developers/overview/managing-deploy-keys) are unable to be used with repositories containing LFS objects.
|
||||
- Jupyter Notebook rendering in the web UI may fail if the notebook includes non UTF-8 encoded characters.
|
||||
- Jupyter Notebook rendering in the web UI may fail if the notebook includes non-ASCII UTF-8 characters.
|
||||
- reStructuredText (RST) rendering in the web UI may fail and instead display raw RST markup text.
|
||||
- Dependency graph fails to parse `setup.py` Python manifest files, resulting in HTTP 500 errors in logs. This, combined with the duplicated logging issue, results in increased root volume utilization.
|
||||
- A race condition can cause dependency graph database migrations to appear to fail.
|
||||
|
||||
@@ -39,7 +39,7 @@ sections:
|
||||
- 'Users can dismiss a mandatory message without checking all checkboxes.'
|
||||
- '[Pre-receive hook scripts](/admin/policies/enforcing-policy-with-pre-receive-hooks) cannot write temporary files, which may cause script execution to fail. Users who use pre-receive hooks should test in a staging environment to see if scripts require write access.'
|
||||
- 'Repository [deploy keys](/developers/overview/managing-deploy-keys) are unable to be used with repositories containing LFS objects.'
|
||||
- 'Jupyter Notebook rendering in the web UI may fail if the notebook includes non UTF-8 encoded characters.'
|
||||
- Jupyter Notebook rendering in the web UI may fail if the notebook includes non-ASCII UTF-8 characters.
|
||||
- 'reStructuredText (RST) rendering in the web UI may fail and instead display raw RST markup text.'
|
||||
- 'Dependency graph fails to parse `yarn.lock` Javascript manifest files, resulting in HTTP 500 errors in logs.'
|
||||
- 'Instances with a custom timezone that were upgraded from an earlier release of GitHub Enterprise Server may have incorrect timestamps in the web UI.'
|
||||
|
||||