Merge branch 'main' into 3634-dependabot-combined-notification
This commit is contained in:
mc
14
.github/ISSUE_COMMENT_TEMPLATE/target-date.yml
vendored
Normal file
14
.github/ISSUE_COMMENT_TEMPLATE/target-date.yml
vendored
Normal file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
name: Target Date Update
|
||||
about: Target date update
|
||||
body:
|
||||
- type: input
|
||||
attributes:
|
||||
name: Target completion date
|
||||
placeholder: With context if the target completion date has changed
|
||||
inputType: text
|
||||
- type: input
|
||||
attributes:
|
||||
name: 'Attribution'
|
||||
value: '_created with :heart: by typing_ `/status`'
|
||||
inputType: text
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 30 KiB |
BIN
assets/images/help/notifications-v2/mobile-watch-button.png
Normal file
BIN
assets/images/help/notifications-v2/mobile-watch-button.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 150 KiB |
BIN
assets/images/help/notifications-v2/mobile-watch-settings.png
Normal file
BIN
assets/images/help/notifications-v2/mobile-watch-settings.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 179 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 240 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 493 KiB After Width: | Height: | Size: 424 KiB |
@@ -228,9 +228,9 @@ includeGuides:
|
||||
- Optional.
|
||||
|
||||
### `topics`
|
||||
- Purpose: Indicate the topics covered by the article.
|
||||
- Type: `String`
|
||||
- Optional.
|
||||
- Purpose: Indicate the topics covered by the article. The topics are used to filter guides on some landing pages. For example, the guides at the bottom of [this page](https://docs.github.com/en/actions/guides) can be filtered by topics and the topics are listed under the guide intro. Topics are also added to all search records that get created for each page. The search records contain a `topics` property that is used to filter search results by topics. For more information, see the [Search](/contributing/search.md) contributing guide. Refer to the content models for more details around adding topics. A full list of existing topics is located in the [allowed topics file](/data/allowed-topics.js). If topics in article frontmatter and the allow-topics list become out of sync, the [topics CI test](/tests/unit/search/topics.js) will fail.
|
||||
- Type: Array of `String`s
|
||||
- Optional: Topics are preferred for each article, but, there may be cases where existing articles don't yet have topics or a adding a topic to a new article may not add value.
|
||||
|
||||
### `contributor`
|
||||
- Purpose: Indicate an article is contributed and maintained by a third-party organization, typically a GitHub Technology Partner.
|
||||
|
||||
68
content/actions/guides/adding-labels-to-issues.md
Normal file
68
content/actions/guides/adding-labels-to-issues.md
Normal file
@@ -0,0 +1,68 @@
|
||||
---
|
||||
title: Adding labels to issues
|
||||
intro: You can use {% data variables.product.prodname_actions %} to automatically label issues.
|
||||
product: '{% data reusables.gated-features.actions %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '>=2.22'
|
||||
github-ae: '*'
|
||||
type: 'tutorial'
|
||||
topics:
|
||||
- 'Workflows'
|
||||
- 'Project management'
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
{% data reusables.actions.ae-beta %}
|
||||
{% data reusables.actions.ae-self-hosted-runners-notice %}
|
||||
|
||||
### Introduction
|
||||
|
||||
This tutorial demonstrates how to use the [`andymckay/labeler` action](https://github.com/marketplace/actions/simple-issue-labeler) in a workflow to label newly opened or reopened issues. For example, you can add the `triage` label every time an issue is opened or reopened. Then, you can see all issues that need to be triaged by filtering for issues with the `triage` label.
|
||||
|
||||
In the tutorial, you will first make a workflow file that uses the [`andymckay/labeler` action](https://github.com/marketplace/actions/simple-issue-labeler). Then, you will customize the workflow to suit your needs.
|
||||
|
||||
### Creating the workflow
|
||||
|
||||
1. {% data reusables.actions.choose-repo %}
|
||||
2. {% data reusables.actions.make-workflow-file %}
|
||||
3. Copy the following YAML contents into your workflow file.
|
||||
|
||||
{% raw %}
|
||||
```yaml{:copy}
|
||||
name: Label issues
|
||||
on:
|
||||
issues:
|
||||
types:
|
||||
- reopened
|
||||
- opened
|
||||
jobs:
|
||||
label_issues:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Label issues
|
||||
uses: andymckay/labeler@1.0.2
|
||||
with:
|
||||
add-labels: "triage"
|
||||
```
|
||||
{% endraw %}
|
||||
4. Customize the parameters in your workflow file:
|
||||
- Change the value for `add-labels` to the list of labels that you want to add to the issue. Separate multiple labels with commas. For example, `"help wanted, good first issue"`. For more information about labels, see "[Managing labels](/github/managing-your-work-on-github/managing-labels#applying-labels-to-issues-and-pull-requests)."
|
||||
5. {% data reusables.actions.commit-workflow %}
|
||||
|
||||
### Testing the workflow
|
||||
|
||||
Every time an issue in your repository is opened or reopened, this workflow will add the labels that you specified to the issue.
|
||||
|
||||
Test out your workflow by creating an issue in your repository.
|
||||
|
||||
1. Create an issue in your repository. For more information, see "[Creating an issue](/github/managing-your-work-on-github/creating-an-issue)."
|
||||
2. To see the workflow run that was triggered by creating the issue, view the history of your workflow runs. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)."
|
||||
3. When the workflow completes, the issue that you created should have the specified labels added.
|
||||
|
||||
### Next steps
|
||||
|
||||
- To learn more about additional things you can do with the `andymckay/labeler` action, like removing labels or skipping this action if the issue is assigned or has a specific label, see the [`andymckay/labeler` action documentation](https://github.com/marketplace/actions/simple-issue-labeler).
|
||||
- To learn more about different events that can trigger your workflow, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#issues)." The `andymckay/labeler` action only works on `issues`, `pull_request`, or `project_card` events.
|
||||
- [Search GitHub](https://github.com/search?q=%22uses:+andymckay/labeler%22&type=code) for examples of workflows using this action.
|
||||
77
content/actions/guides/closing-inactive-issues.md
Normal file
77
content/actions/guides/closing-inactive-issues.md
Normal file
@@ -0,0 +1,77 @@
|
||||
---
|
||||
title: Closing inactive issues
|
||||
intro: You can use {% data variables.product.prodname_actions %} to comment on or close issues that have been inactive for a certain period of time.
|
||||
product: '{% data reusables.gated-features.actions %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '>=2.22'
|
||||
github-ae: '*'
|
||||
type: 'tutorial'
|
||||
topics:
|
||||
- 'Workflows'
|
||||
- 'Project management'
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
{% data reusables.actions.ae-beta %}
|
||||
{% data reusables.actions.ae-self-hosted-runners-notice %}
|
||||
|
||||
### Introduction
|
||||
|
||||
This tutorial demonstrates how to use the [`actions/stale` action](https://github.com/marketplace/actions/close-stale-issues) to comment on and close issues that have been inactive for a certain period of time. For example, you can comment if an issue has been inactive for 30 days to prompt participants to take action. Then, if no additional activity occurs after 14 days, you can close the issue.
|
||||
|
||||
In the tutorial, you will first make a workflow file that uses the [`actions/stale` action](https://github.com/marketplace/actions/close-stale-issues). Then, you will customize the workflow to suit your needs.
|
||||
|
||||
### Creating the workflow
|
||||
|
||||
1. {% data reusables.actions.choose-repo %}
|
||||
2. {% data reusables.actions.make-workflow-file %}
|
||||
3. Copy the following YAML contents into your workflow file.
|
||||
|
||||
{% raw %}
|
||||
```yaml{:copy}
|
||||
name: Close inactive issues
|
||||
on:
|
||||
schedule:
|
||||
- cron: "30 1 * * *"
|
||||
|
||||
jobs:
|
||||
close-issues:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/stale@v3
|
||||
with:
|
||||
days-before-issue-stale: 30
|
||||
days-before-issue-close: 14
|
||||
stale-issue-label: "stale"
|
||||
stale-issue-message: "This issue is stale because it has been open for 30 days with no activity."
|
||||
close-issue-message: "This issue was closed because it has been inactive for 14 days since being marked as stale."
|
||||
days-before-pr-stale: -1
|
||||
days-before-pr-close: -1
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
```
|
||||
{% endraw %}
|
||||
4. Customize the parameters in your workflow file:
|
||||
- Change the value for `on.schedule` to dictate when you want this workflow to run. In the example above, the workflow will run every day at 1:30 UTC. For more information about scheduled workflows, see "[Scheduled events](/actions/reference/events-that-trigger-workflows#scheduled-events)."
|
||||
- Change the value for `days-before-issue-stale` to the number of days without activity before the `actions/stale` action labels an issue. If you never want this action to label issues, set this value to `-1`.
|
||||
- Change the value for `days-before-issue-close` to the number of days without activity before the `actions/stale` action closes an issue. If you never want this action to close issues, set this value to `-1`.
|
||||
- Change the value for `stale-issue-label` to the label that you want to apply to issues that have been inactive for the amount of time specified by `days-before-issue-stale`.
|
||||
- Change the value for `stale-issue-message` to the comment that you want to add to issues that are labeled by the `actions/stale` action.
|
||||
- Change the value for `close-issue-message` to the comment that you want to add to issues that are closed by the `actions/stale` action.
|
||||
5. {% data reusables.actions.commit-workflow %}
|
||||
|
||||
### Expected results
|
||||
|
||||
Based on the `schedule` parameter (for example, every day at 1:30 UTC), your workflow will find issues that have been inactive for the specified period of time and will add the specified comment and label. Additionally, your workflow will close any previously labeled issues if no additional activity has occurred for the specified period of time.
|
||||
|
||||
{% data reusables.actions.schedule-delay %}
|
||||
|
||||
You can view the history of your workflow runs to see this workflow run periodically. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)."
|
||||
|
||||
This workflow will only label and/or close 30 issues at a time in order to avoid rate limit abuse. You can configure this with the `operations-per-run` setting. For more information, see the [`actions/stale` action documentation](https://github.com/marketplace/actions/close-stale-issues).
|
||||
|
||||
### Next steps
|
||||
|
||||
- To learn more about additional things you can do with the `actions/stale` action, like closing inactive pull requests, ignoring issues with certain labels or milestones, or only checking issues with certain labels, see the [`actions/stale` action documentation](https://github.com/marketplace/actions/close-stale-issues).
|
||||
- [Search GitHub](https://github.com/search?q=%22uses%3A+actions%2Fstale%22&type=code) for examples of workflows using this action.
|
||||
@@ -0,0 +1,70 @@
|
||||
---
|
||||
title: Commenting on an issue when a label is added
|
||||
intro: You can use {% data variables.product.prodname_actions %} to automatically comment on issues when a specific label is applied.
|
||||
product: '{% data reusables.gated-features.actions %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '>=2.22'
|
||||
github-ae: '*'
|
||||
type: 'tutorial'
|
||||
topics:
|
||||
- 'Workflows'
|
||||
- 'Project management'
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
{% data reusables.actions.ae-beta %}
|
||||
{% data reusables.actions.ae-self-hosted-runners-notice %}
|
||||
|
||||
### Introduction
|
||||
|
||||
This tutorial demonstrates how to use the [`peter-evans/create-or-update-comment` action](https://github.com/marketplace/actions/create-or-update-comment) to comment on an issue when a specific label is applied. For example, when the `help-wanted` label is added to an issue, you can add a comment to encourage contributors to work on the issue.
|
||||
|
||||
In the tutorial, you will first make a workflow file that uses the [`peter-evans/create-or-update-comment` action](https://github.com/marketplace/actions/create-or-update-comment). Then, you will customize the workflow to suit your needs.
|
||||
|
||||
### Creating the workflow
|
||||
|
||||
1. {% data reusables.actions.choose-repo %}
|
||||
2. {% data reusables.actions.make-workflow-file %}
|
||||
3. Copy the following YAML contents into your workflow file.
|
||||
|
||||
{% raw %}
|
||||
```yaml{:copy}
|
||||
name: Add comment
|
||||
on:
|
||||
issues:
|
||||
types:
|
||||
- labeled
|
||||
jobs:
|
||||
add-comment:
|
||||
if: github.event.label.name == 'help-wanted'
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Add comment
|
||||
uses: peter-evans/create-or-update-comment@v1
|
||||
with:
|
||||
issue-number: ${{ github.event.issue.number }}
|
||||
body: |
|
||||
This issue is available for anyone to work on. **Make sure to reference this issue in your pull request.** :sparkles: Thank you for your contribution! :sparkles:
|
||||
```
|
||||
{% endraw %}
|
||||
4. Customize the parameters in your workflow file:
|
||||
- Replace `help-wanted` in `if: github.event.label.name == 'help-wanted'` with the label that you want to act on. If you want to act on more than one label, separate the conditions with `||`. For example, `if: github.event.label.name == 'bug' || github.event.label.name == 'fix me'` will comment whenever the `bug` or `fix me` labels are added to an issue.
|
||||
- Change the value for `body` to the comment that you want to add. GitHub flavored markdown is supported. For more information about markdown, see "[Basic writing and formatting syntax](/github/writing-on-github/basic-writing-and-formatting-syntax)."
|
||||
5. {% data reusables.actions.commit-workflow %}
|
||||
|
||||
### Testing the workflow
|
||||
|
||||
Every time an issue in your repository is labeled, this workflow will run. If the label that was added is one of the labels that you specified in your workflow file, the `peter-evans/create-or-update-comment` action will add the comment that you specified to the issue.
|
||||
|
||||
Test your workflow by applying your specified label to an issue.
|
||||
|
||||
1. Open an issue in your repository. For more information, see "[Creating an issue](/github/managing-your-work-on-github/creating-an-issue)."
|
||||
2. Label the issue with the specified label in your workflow file. For more information, see "[Managing labels](/github/managing-your-work-on-github/managing-labels#applying-labels-to-issues-and-pull-requests)."
|
||||
3. To see the workflow run triggered by labeling the issue, view the history of your workflow runs. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)."
|
||||
4. When the workflow completes, the issue that you labeled should have a comment added.
|
||||
|
||||
### Next steps
|
||||
|
||||
- To learn more about additional things you can do with the `peter-evans/create-or-update-comment` action, like adding reactions, visit the [`peter-evans/create-or-update-comment` action documentation](https://github.com/marketplace/actions/create-or-update-comment).
|
||||
@@ -62,6 +62,13 @@ includeGuides:
|
||||
- /actions/learn-github-actions/migrating-from-gitlab-cicd-to-github-actions
|
||||
- /actions/learn-github-actions/migrating-from-jenkins-to-github-actions
|
||||
- /actions/learn-github-actions/migrating-from-travis-ci-to-github-actions
|
||||
- /actions/guides/using-github-actions-for-project-management
|
||||
- /actions/guides/closing-inactive-issues
|
||||
- /actions/guides/scheduling-issue-creation
|
||||
- /actions/guides/adding-labels-to-issues
|
||||
- /actions/guides/commenting-on-an-issue-when-a-label-is-added
|
||||
- /actions/guides/moving-assigned-issues-on-project-boards
|
||||
- /actions/guides/removing-a-label-when-a-card-is-added-to-a-project-board-column
|
||||
|
||||
---
|
||||
<!-- {% link_in_list /about-continuous-integration %} -->
|
||||
@@ -87,3 +94,11 @@ includeGuides:
|
||||
<!-- {% link_in_list /deploying-to-amazon-elastic-container-service %} -->
|
||||
<!-- {% link_in_list /deploying-to-azure-app-service %} -->
|
||||
<!-- {% link_in_list /deploying-to-google-kubernetes-engine %} -->
|
||||
<!-- {% link_in_list /deploying-to-google-kubernetes-engine %} -->
|
||||
<!-- {% link_in_list /using-github-actions-for-project-management %} -->
|
||||
<!-- {% link_in_list /closing-inactive-issues %} -->
|
||||
<!-- {% link_in_list /scheduling-issue-creation %} -->
|
||||
<!-- {% link_in_list /adding-labels-to-issues %} -->
|
||||
<!-- {% link_in_list /commenting-on-an-issue-when-a-label-is-added %} -->
|
||||
<!-- {% link_in_list /moving-assigned-issues-on-project-boards %} -->
|
||||
<!-- {% link_in_list /removing-a-label-when-a-card-is-added-to-a-project-board-column %} -->
|
||||
|
||||
@@ -0,0 +1,75 @@
|
||||
---
|
||||
title: Moving assigned issues on project boards
|
||||
intro: You can use {% data variables.product.prodname_actions %} to automatically move an issue to a specific column on a project board when the issue is assigned.
|
||||
product: '{% data reusables.gated-features.actions %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '>=2.22'
|
||||
github-ae: '*'
|
||||
type: 'tutorial'
|
||||
topics:
|
||||
- 'Workflows'
|
||||
- 'Project management'
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
{% data reusables.actions.ae-beta %}
|
||||
{% data reusables.actions.ae-self-hosted-runners-notice %}
|
||||
|
||||
### Introduction
|
||||
|
||||
This tutorial demonstrates how to use the [`alex-page/github-project-automation-plus` action](https://github.com/marketplace/actions/github-project-automation) to automatically move an issue to a specific column on a project board when the issue is assigned. For example, when an issue is assigned, you can move it into the `In Progress` column your project board.
|
||||
|
||||
In the tutorial, you will first make a workflow file that uses the [`alex-page/github-project-automation-plus` action](https://github.com/marketplace/actions/github-project-automation). Then, you will customize the workflow to suit your needs.
|
||||
|
||||
### Creating the workflow
|
||||
|
||||
1. {% data reusables.actions.choose-repo %}
|
||||
2. In your repository, choose a project board. You can use an existing project, or you can create a new project. For more information about creating a project, see "[Creating a project board](/github/managing-your-work-on-github/creating-a-project-board)."
|
||||
3. {% data reusables.actions.make-workflow-file %}
|
||||
4. Copy the following YAML contents into your workflow file.
|
||||
|
||||
{% raw %}
|
||||
```yaml{:copy}
|
||||
name: Move assigned card
|
||||
on:
|
||||
issues:
|
||||
types:
|
||||
- assigned
|
||||
jobs:
|
||||
move-assigned-card:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: alex-page/github-project-automation-plus@v0.3.0
|
||||
with:
|
||||
project: Docs Work
|
||||
column: In Progress
|
||||
repo-token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
|
||||
```
|
||||
{% endraw %}
|
||||
5. Customize the parameters in your workflow file:
|
||||
- Change the value for `project` to the name of your project board. If you have multiple project boards with the same name, the `alex-page/github-project-automation-plus` action will act on all projects with the specified name.
|
||||
- Change the value for `column` to the name of the column where you want issues to move when they are assigned.
|
||||
- Change the value for `repo-token`:
|
||||
1. Create a personal access token with the `repo` scope. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)."
|
||||
1. Store this personal access token as a secret in your repository. For more information about storing secrets, see "[Encrypted secrets](/actions/reference/encrypted-secrets)."
|
||||
1. In your workflow file, replace `PERSONAL_ACCESS_TOKEN` with the name of your secret.
|
||||
6. {% data reusables.actions.commit-workflow %}
|
||||
|
||||
### Testing the workflow
|
||||
|
||||
Whenever an issue in your repository is assigned, the issue will be moved to the specified project board column. If the issue is not already on the project board, it will be added to the project board.
|
||||
|
||||
If your repository is user-owned, the `alex-page/github-project-automation-plus` action will act on all projects in your repository or user account that have the specified project name and column. Likewise, if your repository is organization-owned, the action will act on all projects in your repository or organization that have the specified project name and column.
|
||||
|
||||
Test your workflow by assigning an issue in your repository.
|
||||
|
||||
1. Open an issue in your repository. For more information, see "[Creating an issue](/github/managing-your-work-on-github/creating-an-issue)."
|
||||
2. Assign the issue. For more information, see "[Assigning issues and pull requests to other GitHub users](/github/managing-your-work-on-github/assigning-issues-and-pull-requests-to-other-github-users)."
|
||||
3. To see the workflow run that assigning the issue triggered, view the history of your workflow runs. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)."
|
||||
4. When the workflow completes, the issue that you assigned should be added to the specified project board column.
|
||||
|
||||
### Next steps
|
||||
|
||||
- To learn more about additional things you can do with the `alex-page/github-project-automation-plus` action, like deleting or archiving project cards, visit the [`alex-page/github-project-automation-plus` action documentation](https://github.com/marketplace/actions/github-project-automation).
|
||||
@@ -0,0 +1,75 @@
|
||||
---
|
||||
title: Removing a label when a card is added to a project board column
|
||||
intro: You can use {% data variables.product.prodname_actions %} to automatically remove a label when an issue or pull request is added to a specific column on a project board.
|
||||
product: '{% data reusables.gated-features.actions %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '>=2.22'
|
||||
github-ae: '*'
|
||||
type: 'tutorial'
|
||||
topics:
|
||||
- 'Workflows'
|
||||
- 'Project management'
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
{% data reusables.actions.ae-beta %}
|
||||
{% data reusables.actions.ae-self-hosted-runners-notice %}
|
||||
|
||||
### Introduction
|
||||
|
||||
This tutorial demonstrates how to use the [`andymckay/labeler` action](https://github.com/marketplace/actions/simple-issue-labeler) along with a conditional to remove a label from issues and pull requests that are added to a specific column on a project board. For example, you can remove the `needs review` label when project cards are moved into the `Done` column.
|
||||
|
||||
In the tutorial, you will first make a workflow file that uses the [`andymckay/labeler` action](https://github.com/marketplace/actions/simple-issue-labeler). Then, you will customize the workflow to suit your needs.
|
||||
|
||||
### Creating the workflow
|
||||
|
||||
1. {% data reusables.actions.choose-repo %}
|
||||
2. Choose a project that belongs to the repository. This workflow cannot be used with projects that belong to users or organizations. You can use an existing project, or you can create a new project. For more information about creating a project, see "[Creating a project board](/github/managing-your-work-on-github/creating-a-project-board)."
|
||||
3. {% data reusables.actions.make-workflow-file %}
|
||||
4. Copy the following YAML contents into your workflow file.
|
||||
|
||||
{% raw %}
|
||||
```yaml{:copy}
|
||||
name: Remove labels
|
||||
on:
|
||||
project_card:
|
||||
types:
|
||||
- moved
|
||||
jobs:
|
||||
remove_labels:
|
||||
if: github.event.project_card.column_id == '12345678'
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: remove labels
|
||||
uses: andymckay/labeler@master
|
||||
with:
|
||||
remove-labels: "needs review"
|
||||
```
|
||||
{% endraw %}
|
||||
5. Customize the parameters in your workflow file:
|
||||
- In `github.event.project_card.column_id == '12345678'`, replace `12345678` with the ID of the column where you want to un-label issues and pull requests that are moved there.
|
||||
|
||||
To find the column ID, navigate to your project board. Next to the title of the column, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} then click **Copy column link**. The column ID is the number at the end of the copied link. For example, `24687531` is the column ID for `https://github.com/octocat/octo-repo/projects/1#column-24687531`.
|
||||
|
||||
If you want to act on more than one column, separate the conditions with `||`. For example, `if github.event.project_card.column_id == '12345678' || github.event.project_card.column_id == '87654321'` will act whenever a project card is added to column `12345678` or column `87654321`. The columns may be on different project boards.
|
||||
- Change the value for `remove-labels` to the list of labels that you want to remove from issues or pull requests that are moved to the specified column(s). Separate multiple labels with commas. For example, `"help wanted, good first issue"`. For more information on labels, see "[Managing labels](/github/managing-your-work-on-github/managing-labels#applying-labels-to-issues-and-pull-requests)."
|
||||
6. {% data reusables.actions.commit-workflow %}
|
||||
|
||||
### Testing the workflow
|
||||
|
||||
Every time a project card on a project in your repository moves, this workflow will run. If the card is an issue or a pull request and is moved into the column that you specified, then the workflow will remove the specified labels from the issue or a pull request. Cards that are notes will not be affected.
|
||||
|
||||
Test your workflow out by moving an issue on your project into the target column.
|
||||
|
||||
1. Open an issue in your repository. For more information, see "[Creating an issue](/github/managing-your-work-on-github/creating-an-issue)."
|
||||
2. Label the issue with the labels that you want the workflow to remove. For more information, see "[Managing labels](/github/managing-your-work-on-github/managing-labels#applying-labels-to-issues-and-pull-requests)."
|
||||
3. Add the issue to the project column that you specified in your workflow file. For more information, see "[Adding issues and pull requests to a project board](/github/managing-your-work-on-github/adding-issues-and-pull-requests-to-a-project-board)."
|
||||
4. To see the workflow run that was triggered by adding the issue to the project, view the history of your workflow runs. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)."
|
||||
5. When the workflow completes, the issue that you added to the project column should have the specified labels removed.
|
||||
|
||||
### Next steps
|
||||
|
||||
- To learn more about additional things you can do with the `andymckay/labeler` action, like adding labels or skipping this action if the issue is assigned or has a specific label, visit the [`andymckay/labeler` action documentation](https://github.com/marketplace/actions/simple-issue-labeler).
|
||||
- [Search GitHub](https://github.com/search?q=%22uses:+andymckay/labeler%22&type=code) for examples of workflows using this action.
|
||||
89
content/actions/guides/scheduling-issue-creation.md
Normal file
89
content/actions/guides/scheduling-issue-creation.md
Normal file
@@ -0,0 +1,89 @@
|
||||
---
|
||||
title: Scheduling issue creation
|
||||
intro: You can use {% data variables.product.prodname_actions %} to create an issue on a regular basis for things like daily meetings or quarterly reviews.
|
||||
product: '{% data reusables.gated-features.actions %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '>=2.22'
|
||||
github-ae: '*'
|
||||
type: 'tutorial'
|
||||
topics:
|
||||
- 'Workflows'
|
||||
- 'Project management'
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
{% data reusables.actions.ae-beta %}
|
||||
{% data reusables.actions.ae-self-hosted-runners-notice %}
|
||||
|
||||
### Introduction
|
||||
|
||||
This tutorial demonstrates how to use the [`imjohnbo/issue-bot` action](https://github.com/marketplace/actions/issue-bot-action) to create an issue on a regular basis. For example, you can create an issue each week to use as the agenda for a team meeting.
|
||||
|
||||
In the tutorial, you will first make a workflow file that uses the [`imjohnbo/issue-bot` action](https://github.com/marketplace/actions/issue-bot-action). Then, you will customize the workflow to suit your needs.
|
||||
|
||||
### Creating the workflow
|
||||
|
||||
1. {% data reusables.actions.choose-repo %}
|
||||
2. {% data reusables.actions.make-workflow-file %}
|
||||
3. Copy the following YAML contents into your workflow file.
|
||||
|
||||
{% raw %}
|
||||
```yaml{:copy}
|
||||
name: Weekly Team Sync
|
||||
on:
|
||||
schedule:
|
||||
- cron: 0 07 * * 1
|
||||
|
||||
jobs:
|
||||
create_issue:
|
||||
name: Create team sync issue
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Create team sync issue
|
||||
uses: imjohnbo/issue-bot@v3.0
|
||||
with:
|
||||
assignees: "monalisa, doctocat, hubot"
|
||||
labels: "weekly sync, docs-team"
|
||||
title: "Team sync"
|
||||
body: |
|
||||
### Agenda
|
||||
|
||||
- [ ] Start the recording
|
||||
- [ ] Check-ins
|
||||
- [ ] Discussion points
|
||||
- [ ] Post the recording
|
||||
|
||||
### Discussion Points
|
||||
Add things to discuss below
|
||||
|
||||
- [Work this week](https://github.com/orgs/github/projects/3)
|
||||
pinned: false
|
||||
close-previous: false
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
```
|
||||
{% endraw %}
|
||||
4. Customize the parameters in your workflow file:
|
||||
- Change the value for `on.schedule` to dictate when you want this workflow to run. In the example above, the workflow will run every Monday at 7:00 UTC. For more information about scheduled workflows, see "[Scheduled events](/actions/reference/events-that-trigger-workflows#scheduled-events)."
|
||||
- Change the value for `assignees` to the list of {% data variables.product.prodname_dotcom %} usernames that you want to assign to the issue.
|
||||
- Change the value for `labels` to the list of labels that you want to apply to the issue.
|
||||
- Change the value for `title` to the title that you want the issue to have.
|
||||
- Change the value for `body` to the text that you want in the issue body. The `|` character allows you to use a multi-line value for this parameter.
|
||||
- If you want to pin this issue in your repository, set `pinned` to `true`. For more information about pinned issues, see "[Pinning an issue to your repository](/articles/pinning-an-issue-to-your-repository)."
|
||||
- If you want to close the previous issue generated by this workflow each time a new issue is created, set `close-previous` to `true`. The workflow will close the most recent issue that has the labels defined in the `labels` field. To avoid closing the wrong issue, use a unique label or combination of labels.
|
||||
5. {% data reusables.actions.commit-workflow %}
|
||||
|
||||
### Expected results
|
||||
|
||||
Based on the `schedule` parameter (for example, every Monday at 7:00 UTC), your workflow will create a new issue with the assignees, labels, title, and body that you specified. If you set `pinned` to `true`, the workflow will pin the issue to your repository. If you set `close-previous` to true, the workflow will close the most recent issue with matching labels.
|
||||
|
||||
{% data reusables.actions.schedule-delay %}
|
||||
|
||||
You can view the history of your workflow runs to see this workflow run periodically. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)."
|
||||
|
||||
### Next steps
|
||||
|
||||
- To learn more about additional things you can do with the `imjohnbo/issue-bot` action, like rotating assignees or using an issue template, see the [`imjohnbo/issue-bot` action documentation](https://github.com/marketplace/actions/issue-bot-action).
|
||||
- [Search GitHub](https://github.com/search?q=%22uses%3A+imjohnbo%2Fissue-bot%22&type=code) for examples of workflows using this action.
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
title: Using GitHub Actions for project management
|
||||
intro: You can use {% data variables.product.prodname_actions %} to automate many of your project management tasks.
|
||||
product: '{% data reusables.gated-features.actions %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '>=2.22'
|
||||
github-ae: '*'
|
||||
type: 'overview'
|
||||
topics:
|
||||
- 'Project management'
|
||||
---
|
||||
|
||||
You can use {% data variables.product.prodname_actions %} to automate your project management tasks by creating workflows. Each workflow contains a series of tasks that are performed automatically every time the workflow runs. For example, you can create a workflow that runs every time an issue is created to add a label, leave a comment, and move the issue onto a project board.
|
||||
|
||||
### When do workflows run?
|
||||
|
||||
You can configure your workflows to run on a schedule or be triggered when an event occurs. For example, you can set your workflow to run when someone creates an issue in a repository.
|
||||
|
||||
Many workflow triggers are useful for automating project management.
|
||||
|
||||
- An issue is opened, assigned, or labeled.
|
||||
- A comment is added to an issue.
|
||||
- A project card is created or moved.
|
||||
- A scheduled time.
|
||||
|
||||
For a full list of events that can trigger workflows, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)."
|
||||
|
||||
### What can workflows do?
|
||||
|
||||
Workflows can do many things, such as commenting on an issue, adding or removing labels, moving cards on project boards, and opening issues.
|
||||
|
||||
You can learn about using {% data variables.product.prodname_actions %} for project management by following these tutorials, which include example workflows that you can adapt to meet your needs.
|
||||
|
||||
- "[Adding labels to issues](/actions/guides/adding-labels-to-issues)"
|
||||
- "[Removing a label when a card is added to a project board column](/actions/guides/removing-a-label-when-a-card-is-added-to-a-project-board-column)"
|
||||
- "[Moving assigned issues on project boards](/actions/guides/moving-assigned-issues-on-project-boards)"
|
||||
- "[Commenting on an issue when a label is added](/actions/guides/commenting-on-an-issue-when-a-label-is-added)"
|
||||
- "[Closing inactive issues](/actions/guides/closing-inactive-issues)"
|
||||
- "[Scheduling issue creation](/actions/guides/scheduling-issue-creation)"
|
||||
@@ -123,6 +123,24 @@ For example, you can use the audit log to track the `org.update_actions_secret`
|
||||
The following tables describe the {% data variables.product.prodname_actions %} events that you can find in the audit log. For more information on using the audit log, see
|
||||
"[Reviewing the audit log for your organization](/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)."
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
#### Events for environments
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| `environment.create_actions_secret` | Triggered when a secret is created in an environment. For more information, see ["Environment secrets](/actions/reference/environments#environment-secrets)."
|
||||
| `environment.delete` | Triggered when an environment is deleted. For more information, see ["Deleting an environment](/actions/reference/environments#deleting-an-environment)."
|
||||
| `environment.remove_actions_secret` | Triggered when a secret is removed from an environment. For more information, see ["Environment secrets](/actions/reference/environments#environment-secrets)."
|
||||
| `environment.update_actions_secret` | Triggered when a secret in an environment is updated. For more information, see ["Environment secrets](/actions/reference/environments#environment-secrets)."
|
||||
{% endif %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
|
||||
#### Events for configuration changes
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| `repo.actions_enabled` | Triggered when {% data variables.product.prodname_actions %} is enabled for a repository. Can be viewed using the UI. This event is not visible when you access the audit log using the REST API. For more information, see "[Using the REST API](#using-the-rest-api)."
|
||||
{% endif %}
|
||||
|
||||
#### Events for secret management
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
@@ -135,11 +153,15 @@ The following tables describe the {% data variables.product.prodname_actions %}
|
||||
|
||||
#### Events for self-hosted runners
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
|------------------|-------------------{% if currentVersion ver_gt "enterprise-server@2.21" %}{% else %}
|
||||
| `enterprise.register_self_hosted_runner` | Triggered when a new self-hosted runner is registered. For more information, see "[Adding a self-hosted runner to an enterprise](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-an-enterprise)."
|
||||
| `enterprise.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)."
|
||||
| `enterprise.remove_self_hosted_runner` | Triggered when a self-hosted runner is removed.
|
||||
| `enterprise.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)."
|
||||
| `enterprise.self_hosted_runner_updated` | Triggered when the runner application is updated. Can be viewed using the REST API and the UI. This event is not included when you export the audit log as JSON data or a CSV file. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)" and "[Reviewing the audit log for your organization](/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#exporting-the-audit-log)."{% endif %}
|
||||
| `org.register_self_hosted_runner` | Triggered when a new self-hosted runner is registered. For more information, see "[Adding a self-hosted runner to an organization](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-an-organization)."
|
||||
| `org.remove_self_hosted_runner` | Triggered when a self-hosted runner is removed. For more information, see [Removing a runner from an organization](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-an-organization).
|
||||
| `org.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)."
|
||||
| `org.runner_group_updated` | Triggered when the configuration of a self-hosted runner group is changed. For more information, see "[Changing the access policy of a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)."
|
||||
| `org.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)."
|
||||
| `repo.register_self_hosted_runner` | Triggered when a new self-hosted runner is registered. For more information, see "[Adding a self-hosted runner to a repository](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-a-repository)."
|
||||
| `repo.remove_self_hosted_runner` | Triggered when a self-hosted runner is removed. For more information, see "[Removing a runner from a repository](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-a-repository)."
|
||||
@@ -150,13 +172,13 @@ The following tables describe the {% data variables.product.prodname_actions %}
|
||||
|------------------|-------------------
|
||||
| `enterprise.runner_group_created` | Triggered when a self-hosted runner group is created. For more information, see "[Creating a self-hosted runner group for an enterprise](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-enterprise)."
|
||||
| `enterprise.runner_group_removed` | Triggered when a self-hosted runner group is removed. For more information, see "[Removing a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group)."
|
||||
| `enterprise.runner_group_runner_removed` | Triggered when a self-hosted runner is removed from a group.
|
||||
| `enterprise.runner_group_runner_removed` | Triggered when the REST API is used to remove a self-hosted runner from a group.
|
||||
| `enterprise.runner_group_runners_added` | Triggered when a self-hosted runner is added to a group. For more information, see "[Moving a self-hosted runner to a group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group)."
|
||||
| `enterprise.runner_group_updated` |Triggered when the configuration of a self-hosted runner group is changed. For more information, see "[Changing the access policy of a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)."
|
||||
| `org.runner_group_created` | Triggered when a self-hosted runner group is created. For more information, see "[Creating a self-hosted runner group for an organization](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-organization)."
|
||||
| `org.runner_group_removed` | Triggered when a self-hosted runner group is removed. For more information, see "[Removing a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group)."
|
||||
| `org.runner_group_runners_added` | Triggered when a self-hosted runner is added to a group. For more information, see "[Moving a self-hosted runner to a group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group)."
|
||||
| `org.runner_group_runner_removed` | Triggered when a self-hosted runner is removed from a group.
|
||||
| `org.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)."
|
||||
|
||||
#### Events for workflow activities
|
||||
|
||||
|
||||
@@ -40,7 +40,7 @@ This example workflow uses the [labeler action](https://github.com/actions/label
|
||||
```yaml
|
||||
name: Pull request labeler
|
||||
on:
|
||||
- pull_request
|
||||
- pull_request_target
|
||||
jobs:
|
||||
triage:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
@@ -43,11 +43,7 @@ The following steps occur to trigger a workflow run:
|
||||
|
||||
The `schedule` event allows you to trigger a workflow at a scheduled time.
|
||||
|
||||
{% note %}
|
||||
|
||||
Note: Due to load, the `schedule` event may be delayed
|
||||
|
||||
{% endnote %}
|
||||
{% data reusables.actions.schedule-delay %}
|
||||
|
||||
#### `schedule`
|
||||
|
||||
@@ -725,12 +721,14 @@ on:
|
||||
{% data reusables.github-actions.branch-requirement %}
|
||||
|
||||
| Webhook event payload | Activity types | `GITHUB_SHA` | `GITHUB_REF` |
|
||||
| --------------------- | -------------- | ------------ | -------------|
|
||||
| [`workflow_run`](/webhooks/event-payloads/#workflow_run) | - n/a | Last commit on default branch | Default branch |
|
||||
| --------------------- | -------------- | ------------ | -------------|
|
||||
| [`workflow_run`](/webhooks/event-payloads/#workflow_run) | - `completed`<br/>- `requested` | Last commit on default branch | Default branch |
|
||||
|
||||
{% data reusables.developer-site.limit_workflow_to_activity_types %}
|
||||
|
||||
If you need to filter branches from this event, you can use `branches` or `branches-ignore`.
|
||||
|
||||
In this example, a workflow is configured to run after the separate “Run Tests” workflow completes.
|
||||
In this example, a workflow is configured to run after the separate "Run Tests" workflow completes.
|
||||
|
||||
```yaml
|
||||
on:
|
||||
@@ -744,6 +742,27 @@ on:
|
||||
|
||||
{% endif %}
|
||||
|
||||
To run a workflow job conditionally based on the result of the previous workflow run, you can use the [`jobs.<job_id>.if`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idif) or [`jobs.<job_id>.steps[*].if`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsif) conditional combined with the `conclusion` of the previous run. For example:
|
||||
|
||||
```yaml
|
||||
on:
|
||||
workflow_run:
|
||||
workflows: ["Build"]
|
||||
types: [completed]
|
||||
|
||||
jobs:
|
||||
on-success:
|
||||
runs-on: ubuntu-latest
|
||||
if: {% raw %}${{ github.event.workflow_run.conclusion == 'success' }}{% endraw %}
|
||||
steps:
|
||||
...
|
||||
on-failure:
|
||||
runs-on: ubuntu-latest
|
||||
if: {% raw %}${{ github.event.workflow_run.conclusion == 'failure' }}{% endraw %}
|
||||
steps:
|
||||
...
|
||||
```
|
||||
|
||||
### Triggering new workflows using a personal access token
|
||||
|
||||
{% data reusables.github-actions.actions-do-not-trigger-workflows %} For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)."
|
||||
|
||||
@@ -8,6 +8,8 @@ versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '>=2.22'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- billing
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
|
||||
@@ -314,7 +314,6 @@ Available {% data variables.product.prodname_dotcom %}-hosted runner types are:
|
||||
|
||||
{% data reusables.github-actions.supported-github-runners %}
|
||||
|
||||
{% data reusables.github-actions.ubuntu-runner-preview %}
|
||||
{% data reusables.github-actions.macos-runner-preview %}
|
||||
|
||||
##### Example
|
||||
|
||||
@@ -55,7 +55,6 @@ Hardware specification for macOS virtual machines:
|
||||
|
||||
{% data reusables.github-actions.supported-github-runners %}
|
||||
|
||||
{% data reusables.github-actions.ubuntu-runner-preview %}
|
||||
{% data reusables.github-actions.macos-runner-preview %}
|
||||
|
||||
Workflow logs list the runner used to run a job. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)."
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/authentication/allowing-built-in-authentication-for-users-outside-your-identity-provider
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### About built-in authentication for users outside your identity provider
|
||||
|
||||
@@ -11,5 +11,7 @@ redirect_from:
|
||||
mapTopic: true
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/authentication/changing-authentication-methods
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
User accounts on {% data variables.product.product_location %} are preserved when you change the authentication method and users will continue to log into the same account as long as their username doesn't change.
|
||||
|
||||
|
||||
@@ -7,6 +7,8 @@ redirect_from:
|
||||
intro: 'If you''re using built-in authentication, you can block unauthenticated people from being able to create an account.'
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
||||
|
||||
@@ -1,11 +1,13 @@
|
||||
---
|
||||
title: Authentication
|
||||
intro: You can configure how users sign into {% data variables.product.product_name %}.
|
||||
intro: 'You can configure how users sign into {% data variables.product.product_name %}.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/authentication
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/authentication/using-built-in-authentication
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
You can create custom messages that users will see on the sign in and sign out pages. For more information, see "[Customizing user messages on your instance](/enterprise/admin/user-management/customizing-user-messages-on-your-instance)."
|
||||
|
||||
@@ -8,6 +8,8 @@ redirect_from:
|
||||
intro: 'CAS is a single sign-on (SSO) protocol for multiple web applications. A CAS user account does not take up a {% if currentVersion ver_gt "enterprise-server@2.16" %}user license{% else %}seat{% endif %} until the user signs in.'
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
{% data reusables.enterprise_user_management.built-in-authentication %}
|
||||
|
||||
@@ -11,6 +11,8 @@ redirect_from:
|
||||
intro: 'LDAP lets you authenticate {% data variables.product.prodname_ghe_server %} against your existing accounts and centrally manage repository access. LDAP is a popular application protocol for accessing and maintaining directory information services, and is one of the most common protocols used to integrate third-party software with large company user directories.'
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
{% data reusables.enterprise_user_management.built-in-authentication %}
|
||||
|
||||
@@ -8,6 +8,8 @@ redirect_from:
|
||||
intro: 'SAML is an XML-based standard for authentication and authorization. {% data variables.product.prodname_ghe_server %} can act as a service provider (SP) with your internal SAML identity provider (IdP).'
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
{% data reusables.enterprise_user_management.built-in-authentication %}
|
||||
|
||||
@@ -4,6 +4,8 @@ intro: 'You can use the site admin dashboard{% if enterpriseServerVersions conta
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
{% if enterpriseServerVersions contains currentVersion %}
|
||||
|
||||
@@ -13,6 +13,8 @@ redirect_from:
|
||||
intro: '{% data reusables.enterprise_site_admin_settings.about-ssh-access %}'
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### About administrative shell access
|
||||
|
||||
@@ -12,6 +12,8 @@ redirect_from:
|
||||
- /enterprise/admin/configuration/accessing-the-management-console
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### About the {% data variables.enterprise.management_console %}
|
||||
|
||||
@@ -9,6 +9,8 @@ redirect_from:
|
||||
miniTocMaxHeadingLevel: 4
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
You can execute these commands from anywhere on the VM after signing in as an SSH admin user. For more information, see "[Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/)."
|
||||
|
||||
|
||||
@@ -7,6 +7,8 @@ redirect_from:
|
||||
- /enterprise/admin/configuration/configuring-a-hostname
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
If you configure a hostname instead of a hard-coded IP address, you will be able to change the physical hardware that {% data variables.product.product_location %} runs on without affecting users or client software.
|
||||
|
||||
@@ -7,5 +7,7 @@ redirect_from:
|
||||
- /enterprise/admin/configuration/configuring-advanced-security-features
|
||||
versions:
|
||||
enterprise-server: '>=2.22'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
|
||||
@@ -7,6 +7,8 @@ redirect_from:
|
||||
- /enterprise/admin/configuration/configuring-an-outbound-web-proxy-server
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
When a proxy server is enabled for {% data variables.product.product_location %}, outbound messages sent by {% data variables.product.prodname_ghe_server %} are first sent through the proxy server, unless the destination host is added as an HTTP proxy exclusion. Types of outbound messages include outgoing webhooks, uploading bundles, and fetching legacy avatars. The proxy server's URL is the protocol, domain or IP address, plus the port number, for example `http://127.0.0.1:8123`.
|
||||
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/configuration/configuring-applications
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### Adjusting image caching
|
||||
|
||||
@@ -15,6 +15,8 @@ redirect_from:
|
||||
intro: 'As part of a disaster recovery plan, you can protect production data on {% data variables.product.product_location %} by configuring automated backups.'
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### About {% data variables.product.prodname_enterprise_backup_utilities %}
|
||||
|
||||
@@ -7,6 +7,8 @@ redirect_from:
|
||||
- /enterprise/admin/configuration/configuring-built-in-firewall-rules
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### About {% data variables.product.product_location %}'s firewall
|
||||
|
||||
@@ -8,6 +8,8 @@ redirect_from:
|
||||
- /enterprise/admin/configuration/configuring-code-scanning-for-your-appliance
|
||||
versions:
|
||||
enterprise-server: '>=2.22'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
{% data reusables.code-scanning.beta %}
|
||||
|
||||
@@ -7,6 +7,8 @@ redirect_from:
|
||||
- /enterprise/admin/configuration/configuring-dns-nameservers
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
The nameservers you specify must resolve {% data variables.product.product_location %}'s hostname.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Configuring email for notifications
|
||||
intro: To make it easy for users to respond quickly to activity on {% data variables.product.product_name %}, you can configure {% data variables.product.product_location %} to send email notifications for issue, pull request, and commit comments.
|
||||
intro: 'To make it easy for users to respond quickly to activity on {% data variables.product.product_name %}, you can configure {% data variables.product.product_location %} to send email notifications for issue, pull request, and commit comments.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/guides/installation/email-configuration/
|
||||
- /enterprise/admin/articles/configuring-email/
|
||||
@@ -10,6 +10,8 @@ redirect_from:
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
{% if currentVersion == "github-ae@latest" %}
|
||||
|
||||
@@ -11,6 +11,8 @@ redirect_from:
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### Enabling public sites for {% data variables.product.prodname_pages %}
|
||||
|
||||
@@ -11,5 +11,7 @@ intro: 'Configure {% data variables.product.prodname_ghe_server %} with the DNS
|
||||
mapTopic: true
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/configuration/configuring-rate-limits
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### Enabling rate limits for {% data variables.product.prodname_enterprise_api %}
|
||||
|
||||
@@ -6,6 +6,8 @@ product: '{% data reusables.gated-features.secret-scanning %}'
|
||||
miniTocMaxHeadingLevel: 4
|
||||
versions:
|
||||
enterprise-server: '>=3.0'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
{% data reusables.secret-scanning.beta %}
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/configuration/configuring-the-ip-address-using-the-virtual-machine-console
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
{% note %}
|
||||
|
||||
@@ -10,6 +10,8 @@ redirect_from:
|
||||
- /enterprise/admin/configuration/configuring-time-synchronization
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### Changing the default NTP servers
|
||||
|
||||
@@ -8,6 +8,8 @@ redirect_from:
|
||||
- /enterprise/admin/configuration/configuring-tls
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### About Transport Layer Security
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Configuring your enterprise
|
||||
intro: "After {% data variables.product.product_name %} is up and running, you can configure your enterprise to suit your organization's needs."
|
||||
intro: 'After {% data variables.product.product_name %} is up and running, you can configure your enterprise to suit your organization''s needs.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/guides/installation/basic-configuration/
|
||||
- /enterprise/admin/guides/installation/administrative-tools/
|
||||
@@ -12,5 +12,7 @@ mapTopic: true
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
|
||||
@@ -10,6 +10,8 @@ redirect_from:
|
||||
permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable {% data variables.product.prodname_github_connect %}.'
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### About {% data variables.product.prodname_github_connect %}
|
||||
|
||||
@@ -8,6 +8,8 @@ redirect_from:
|
||||
permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}.'
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### About alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}
|
||||
|
||||
@@ -12,6 +12,8 @@ redirect_from:
|
||||
- /enterprise/admin/configuration/enabling-and-scheduling-maintenance-mode
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### About maintenance mode
|
||||
|
||||
@@ -7,6 +7,8 @@ redirect_from:
|
||||
permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable automatic user license synchronization.'
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### About license synchronization
|
||||
|
||||
@@ -9,6 +9,8 @@ redirect_from:
|
||||
- /enterprise/admin/configuration/enabling-private-mode
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
You must enable private mode if {% data variables.product.product_location %} is publicly accessible over the Internet. In private mode, users cannot anonymously clone repositories over `git://`. If built-in authentication is also enabled, an administrator must invite new users to create an account on the instance. For more information, see "[Using built-in authentication](/enterprise/{{ currentVersion }}/admin/guides/user-management/using-built-in-authentication)."
|
||||
|
||||
@@ -7,6 +7,8 @@ redirect_from:
|
||||
- /enterprise/admin/configuration/enabling-subdomain-isolation
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### About subdomain isolation
|
||||
|
||||
@@ -10,6 +10,8 @@ redirect_from:
|
||||
permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable unified contributions between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_dotcom_the_website %}.'
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
As a site administrator, you can allow end users to send anonymized contribution counts for their work from {% data variables.product.prodname_ghe_server %} to their {% data variables.product.prodname_dotcom_the_website %} contribution graph.
|
||||
|
||||
@@ -10,6 +10,8 @@ redirect_from:
|
||||
permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable unified search between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_dotcom_the_website %}.'
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
When you enable unified search, users can view search results from public and private content on {% data variables.product.prodname_dotcom_the_website %} when searching from {% data variables.product.product_location_enterprise %}.
|
||||
|
||||
@@ -1,12 +1,14 @@
|
||||
---
|
||||
title: Configuring GitHub Enterprise
|
||||
shortTitle: Configuring GitHub Enterprise
|
||||
intro: "You can configure your enterprise to suit your organization's needs."
|
||||
intro: You can configure your enterprise to suit your organization's needs.
|
||||
redirect_from:
|
||||
- /enterprise/admin/configuration
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
{% if currentVersion ver_gt "enterprise-server@2.21" %}
|
||||
|
||||
@@ -11,5 +11,7 @@ redirect_from:
|
||||
- /enterprise/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
|
||||
@@ -1,9 +1,11 @@
|
||||
---
|
||||
title: Managing GitHub for mobile for your enterprise
|
||||
intro: You can decide whether authenticated users can connect to {% data variables.product.product_location %} with {% data variables.product.prodname_mobile %}.
|
||||
permissions: Enterprise owners can manage {% data variables.product.prodname_mobile %} for an enterprise on {% data variables.product.product_name %}.
|
||||
intro: 'You can decide whether authenticated users can connect to {% data variables.product.product_location %} with {% data variables.product.prodname_mobile %}.'
|
||||
permissions: 'Enterprise owners can manage {% data variables.product.prodname_mobile %} for an enterprise on {% data variables.product.product_name %}.'
|
||||
versions:
|
||||
enterprise-server: '>=3.0'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
{% if enterpriseServerVersions contains currentVersion %}
|
||||
|
||||
@@ -10,6 +10,8 @@ redirect_from:
|
||||
intro: 'Open network ports selectively based on the network services you need to expose for administrators, end users, and email support.'
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### Administrative ports
|
||||
|
||||
@@ -7,6 +7,8 @@ redirect_from:
|
||||
- /enterprise/admin/configuration/site-admin-dashboard
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
To access the dashboard, in the upper-right corner of any page, click {% octicon "rocket" aria-label="The rocket ship" %}.
|
||||
|
||||
@@ -8,6 +8,8 @@ redirect_from:
|
||||
- /enterprise/admin/configuration/troubleshooting-ssl-errors
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### Removing the passphrase from your key file
|
||||
|
||||
@@ -7,6 +7,8 @@ redirect_from:
|
||||
- /enterprise/admin/configuration/using-github-enterprise-server-with-a-load-balancer
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
{% data reusables.enterprise_clustering.load_balancer_intro %}
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/configuration/validating-your-domain-settings
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
||||
{% data reusables.enterprise_site_admin_settings.management-console %}
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/about-cluster-nodes
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
{% data reusables.enterprise_clustering.clustering-requires-https %}
|
||||
|
||||
@@ -8,6 +8,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/about-clustering
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### Clustering architecture
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/about-geo-replication
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
Multiple active replicas can provide a shorter distance to the nearest replica. For example, an organization with offices in San Francisco, New York, and London could run the primary appliance in a datacenter near New York and two replicas in datacenters near San Francisco and London. Using geolocation-aware DNS, users can be directed to the closest server available and access repository data faster. Designating the appliance near New York as the primary helps reduce the latency between the hosts, compared to the appliance near San Francisco being the primary which has a higher latency to London.
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/about-high-availability-configuration
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
When you configure high availability, there is an automated setup of one-way, asynchronous replication of all datastores (Git repositories, MySQL, Redis, and Elasticsearch) from the primary to the replica appliance.
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/accessing-the-monitor-dashboard
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### Accessing the monitor dashboard
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/cluster-network-configuration
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### Network considerations
|
||||
|
||||
@@ -9,5 +9,7 @@ redirect_from:
|
||||
mapTopic: true
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
|
||||
@@ -7,6 +7,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/configuring-collectd
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
### Set up an external `collectd` server
|
||||
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/configuring-high-availability-replication-for-a-cluster
|
||||
versions:
|
||||
enterprise-server: '>2.21'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### About high availability replication for clusters
|
||||
|
||||
@@ -10,5 +10,7 @@ intro: '{% data variables.product.prodname_ghe_server %} supports a high availab
|
||||
mapTopic: true
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/creating-a-high-availability-replica
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### Creating a high availability replica
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/differences-between-clustering-and-high-availability-ha
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### Failure scenarios
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/enabling-automatic-update-checks
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
When an upgrade package is automatically downloaded for {% data variables.product.product_location %}, you'll receive a message letting you know you can upgrade {% data variables.product.prodname_ghe_server %}. Packages download to the `/var/lib/ghe-updates` directory on {% data variables.product.product_location %}. For more information, see "[Upgrading {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/guides/installation/upgrading-github-enterprise-server)."
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/evacuating-a-cluster-node
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
If you only have three nodes in your data services cluster, you can't evacuate the nodes, because `ghe-spokes` doesn’t have another place to make a copy. If you have four or more, `ghe-spokes` will move all the repositories off of the evacuated node.
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/increasing-cpu-or-memory-resources
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
{% data reusables.enterprise_installation.warning-on-upgrading-physical-resources %}
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/increasing-storage-capacity
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
{% data reusables.enterprise_installation.warning-on-upgrading-physical-resources %}
|
||||
|
||||
@@ -5,6 +5,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/initializing-the-cluster
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
{% data reusables.enterprise_clustering.clustering-requires-https %}
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/initiating-a-failover-to-your-replica-appliance
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
The time required to failover depends on how long it takes to manually promote the replica and redirect traffic. The average time ranges between 2-10 minutes.
|
||||
|
||||
@@ -5,6 +5,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/initiating-a-failover-to-your-replica-cluster
|
||||
versions:
|
||||
enterprise-server: '>2.21'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### About failover to your replica cluster
|
||||
|
||||
@@ -12,6 +12,8 @@ redirect_from:
|
||||
intro: 'To migrate from {% data variables.product.prodname_enterprise %} 11.10.x to 2.1.23, you''ll need to set up a new appliance instance and migrate data from the previous instance.'
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
Migrations from {% data variables.product.prodname_enterprise %} 11.10.348 and later are supported. Migrating from {% data variables.product.prodname_enterprise %} 11.10.348 and earlier is not supported. You must first upgrade to 11.10.348 in several upgrades. For more information, see the 11.10.348 upgrading procedure, "[Upgrading to the latest release](/enterprise/11.10.340/admin/articles/upgrading-to-the-latest-release/)."
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/monitoring-cluster-nodes
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
### Manually checking cluster status
|
||||
|
||||
|
||||
@@ -7,6 +7,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/monitoring-using-snmp
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
SNMP is a common standard for monitoring devices over a network. We strongly recommend enabling SNMP so you can monitor the health of {% data variables.product.product_location %} and know when to add more memory, storage, or processor power to the host machine.
|
||||
|
||||
@@ -9,5 +9,7 @@ redirect_from:
|
||||
mapTopic: true
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
|
||||
@@ -8,6 +8,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/recommended-alert-thresholds
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### Monitoring storage
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/recovering-a-high-availability-configuration
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
You can use the former primary appliance as the new replica appliance if the failover was planned or was not related to the health of the appliance. If the failover was related to an issue with the primary appliance, you may prefer to create a new replica appliance. For more information, see "[Creating a high availability replica](/enterprise/{{ currentVersion }}/admin/guides/installation/creating-a-high-availability-replica/)."
|
||||
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/removing-a-high-availability-replica
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### Stopping replication temporarily
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/replacing-a-cluster-node
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
{% warning %}
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/setting-up-external-monitoring
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### About SNMP
|
||||
|
||||
@@ -9,5 +9,7 @@ redirect_from:
|
||||
mapTopic: true
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
|
||||
@@ -7,6 +7,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/upgrade-requirements
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
{% note %}
|
||||
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/upgrading-a-cluster
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
### Upgrading with a hotpatch
|
||||
{% data reusables.enterprise_installation.hotpatching-explanation %} The hotpatch installation script installs the hotpatch on every node in the cluster and restarts the services in their proper sequence to avoid downtime.
|
||||
|
||||
@@ -15,6 +15,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/upgrading-github-enterprise-server
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- enterprise
|
||||
---
|
||||
|
||||
### Preparing to upgrade
|
||||
@@ -251,4 +253,4 @@ To roll back from a feature release, restore from a VM snapshot to ensure that r
|
||||
### Further reading
|
||||
|
||||
- "[About upgrades to new releases](/admin/overview/about-upgrades-to-new-releases)"
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user