forked from github/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1,226 changed files
with
15,392 additions
and
1,189 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
name: Ready for docs-content review | ||
|
||
# **What it does**: Adds pull requests in the docs-internal repository to the docs-content first responder project board | ||
# **Why we have it**: So that other GitHub teams can easily request reviews from the docs-content team, and so that writers can see when a PR is ready for review | ||
# **Who does it impact**: Writers working in the docs-internal repository | ||
|
||
on: | ||
pull_request: | ||
types: [labeled] | ||
|
||
jobs: | ||
request_doc_review: | ||
name: Request a review from the docs-content team | ||
if: github.event.label.name == 'ready-for-doc-review' && github.repository == 'github/docs-internal' | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Add pull request to FR project board | ||
uses: rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9 | ||
with: | ||
action-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }} | ||
project-url: 'https://github.com/orgs/github/projects/1367' | ||
column-name: 'Docs-internal external contributor PRs' |
This file was deleted.
Oops, something went wrong.
58 changes: 58 additions & 0 deletions
58
.github/workflows/send-issues-to-how-how-we-work-boards.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
name: Send Issue to How We Work Boards | ||
|
||
on: | ||
issues: | ||
types: | ||
- labeled | ||
- reopened | ||
|
||
jobs: | ||
triage: | ||
runs-on: ubuntu-latest | ||
continue-on-error: true | ||
steps: | ||
- if: contains(github.event.issue.labels.*.name, 'engineering') && !contains(github.event.issue.labels.*.name, 'feature') && !contains(github.event.issue.labels.*.name, 'epic') | ||
uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 | ||
with: | ||
github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }} | ||
script: | | ||
var column_id = 9659080; | ||
try { | ||
github.projects.createCard({ | ||
column_id: column_id, | ||
content_id: context.payload.issue.id, | ||
content_type: "Issue" | ||
}); | ||
} catch (error) { | ||
console.log(error); | ||
} | ||
- if: contains(github.event.issue.labels.*.name, 'engineering') && contains(github.event.issue.labels.*.name, 'feature') | ||
uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 | ||
with: | ||
github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }} | ||
script: | | ||
var column_id = 13445681; | ||
try { | ||
github.projects.createCard({ | ||
column_id: column_id, | ||
content_id: context.payload.issue.id, | ||
content_type: "Issue" | ||
}); | ||
} catch (error) { | ||
console.log(error); | ||
} | ||
- if: contains(github.event.issue.labels.*.name, 'engineering') && contains(github.event.issue.labels.*.name, 'epic') | ||
uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 | ||
with: | ||
github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }} | ||
script: | | ||
var column_id = 13445932; | ||
try { | ||
github.projects.createCard({ | ||
column_id: column_id, | ||
content_id: context.payload.issue.id, | ||
content_type: "Issue" | ||
}); | ||
} catch (error) { | ||
console.log(error); | ||
} |
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file modified
BIN
-69.7 KB
(86%)
assets/images/help/package-registry/packages-overview-diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
70 changes: 70 additions & 0 deletions
70
content/actions/guides/commenting-on-an-issue-when-a-label-is-added.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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). |
Oops, something went wrong.