Skip to content

Commit 7deb7a8

Browse files
authored
Merge branch 'main' into 3634-dependabot-combined-notification
2 parents ff2f58a + ddb0c20 commit 7deb7a8

1,207 files changed

Lines changed: 14832 additions & 1074 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Target Date Update
3+
about: Target date update
4+
body:
5+
- type: input
6+
attributes:
7+
name: Target completion date
8+
placeholder: With context if the target completion date has changed
9+
inputType: text
10+
- type: input
11+
attributes:
12+
name: 'Attribution'
13+
value: '_created with :heart: by typing_ `/status`'
14+
inputType: text
-30.4 KB
Binary file not shown.
150 KB
Loading
179 KB
Loading
-240 KB
Binary file not shown.
-69.7 KB
Loading

content/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -228,9 +228,9 @@ includeGuides:
228228
- Optional.
229229

230230
### `topics`
231-
- Purpose: Indicate the topics covered by the article.
232-
- Type: `String`
233-
- Optional.
231+
- 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.
232+
- Type: Array of `String`s
233+
- 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.
234234

235235
### `contributor`
236236
- Purpose: Indicate an article is contributed and maintained by a third-party organization, typically a GitHub Technology Partner.
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: Adding labels to issues
3+
intro: You can use {% data variables.product.prodname_actions %} to automatically label issues.
4+
product: '{% data reusables.gated-features.actions %}'
5+
versions:
6+
free-pro-team: '*'
7+
enterprise-server: '>=2.22'
8+
github-ae: '*'
9+
type: 'tutorial'
10+
topics:
11+
- 'Workflows'
12+
- 'Project management'
13+
---
14+
15+
{% data reusables.actions.enterprise-beta %}
16+
{% data reusables.actions.enterprise-github-hosted-runners %}
17+
{% data reusables.actions.ae-beta %}
18+
{% data reusables.actions.ae-self-hosted-runners-notice %}
19+
20+
### Introduction
21+
22+
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.
23+
24+
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.
25+
26+
### Creating the workflow
27+
28+
1. {% data reusables.actions.choose-repo %}
29+
2. {% data reusables.actions.make-workflow-file %}
30+
3. Copy the following YAML contents into your workflow file.
31+
32+
{% raw %}
33+
```yaml{:copy}
34+
name: Label issues
35+
on:
36+
issues:
37+
types:
38+
- reopened
39+
- opened
40+
jobs:
41+
label_issues:
42+
runs-on: ubuntu-latest
43+
steps:
44+
- name: Label issues
45+
uses: andymckay/labeler@1.0.2
46+
with:
47+
add-labels: "triage"
48+
```
49+
{% endraw %}
50+
4. Customize the parameters in your workflow file:
51+
- 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)."
52+
5. {% data reusables.actions.commit-workflow %}
53+
54+
### Testing the workflow
55+
56+
Every time an issue in your repository is opened or reopened, this workflow will add the labels that you specified to the issue.
57+
58+
Test out your workflow by creating an issue in your repository.
59+
60+
1. Create an issue in your repository. For more information, see "[Creating an issue](/github/managing-your-work-on-github/creating-an-issue)."
61+
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)."
62+
3. When the workflow completes, the issue that you created should have the specified labels added.
63+
64+
### Next steps
65+
66+
- 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).
67+
- 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.
68+
- [Search GitHub](https://github.com/search?q=%22uses:+andymckay/labeler%22&type=code) for examples of workflows using this action.
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
title: Closing inactive issues
3+
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.
4+
product: '{% data reusables.gated-features.actions %}'
5+
versions:
6+
free-pro-team: '*'
7+
enterprise-server: '>=2.22'
8+
github-ae: '*'
9+
type: 'tutorial'
10+
topics:
11+
- 'Workflows'
12+
- 'Project management'
13+
---
14+
15+
{% data reusables.actions.enterprise-beta %}
16+
{% data reusables.actions.enterprise-github-hosted-runners %}
17+
{% data reusables.actions.ae-beta %}
18+
{% data reusables.actions.ae-self-hosted-runners-notice %}
19+
20+
### Introduction
21+
22+
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.
23+
24+
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.
25+
26+
### Creating the workflow
27+
28+
1. {% data reusables.actions.choose-repo %}
29+
2. {% data reusables.actions.make-workflow-file %}
30+
3. Copy the following YAML contents into your workflow file.
31+
32+
{% raw %}
33+
```yaml{:copy}
34+
name: Close inactive issues
35+
on:
36+
schedule:
37+
- cron: "30 1 * * *"
38+
39+
jobs:
40+
close-issues:
41+
runs-on: ubuntu-latest
42+
steps:
43+
- uses: actions/stale@v3
44+
with:
45+
days-before-issue-stale: 30
46+
days-before-issue-close: 14
47+
stale-issue-label: "stale"
48+
stale-issue-message: "This issue is stale because it has been open for 30 days with no activity."
49+
close-issue-message: "This issue was closed because it has been inactive for 14 days since being marked as stale."
50+
days-before-pr-stale: -1
51+
days-before-pr-close: -1
52+
repo-token: ${{ secrets.GITHUB_TOKEN }}
53+
```
54+
{% endraw %}
55+
4. Customize the parameters in your workflow file:
56+
- 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)."
57+
- 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`.
58+
- 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`.
59+
- 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`.
60+
- 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.
61+
- 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.
62+
5. {% data reusables.actions.commit-workflow %}
63+
64+
### Expected results
65+
66+
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.
67+
68+
{% data reusables.actions.schedule-delay %}
69+
70+
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)."
71+
72+
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).
73+
74+
### Next steps
75+
76+
- 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).
77+
- [Search GitHub](https://github.com/search?q=%22uses%3A+actions%2Fstale%22&type=code) for examples of workflows using this action.
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
title: Commenting on an issue when a label is added
3+
intro: You can use {% data variables.product.prodname_actions %} to automatically comment on issues when a specific label is applied.
4+
product: '{% data reusables.gated-features.actions %}'
5+
versions:
6+
free-pro-team: '*'
7+
enterprise-server: '>=2.22'
8+
github-ae: '*'
9+
type: 'tutorial'
10+
topics:
11+
- 'Workflows'
12+
- 'Project management'
13+
---
14+
15+
{% data reusables.actions.enterprise-beta %}
16+
{% data reusables.actions.enterprise-github-hosted-runners %}
17+
{% data reusables.actions.ae-beta %}
18+
{% data reusables.actions.ae-self-hosted-runners-notice %}
19+
20+
### Introduction
21+
22+
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.
23+
24+
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.
25+
26+
### Creating the workflow
27+
28+
1. {% data reusables.actions.choose-repo %}
29+
2. {% data reusables.actions.make-workflow-file %}
30+
3. Copy the following YAML contents into your workflow file.
31+
32+
{% raw %}
33+
```yaml{:copy}
34+
name: Add comment
35+
on:
36+
issues:
37+
types:
38+
- labeled
39+
jobs:
40+
add-comment:
41+
if: github.event.label.name == 'help-wanted'
42+
runs-on: ubuntu-latest
43+
steps:
44+
- name: Add comment
45+
uses: peter-evans/create-or-update-comment@v1
46+
with:
47+
issue-number: ${{ github.event.issue.number }}
48+
body: |
49+
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:
50+
```
51+
{% endraw %}
52+
4. Customize the parameters in your workflow file:
53+
- 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.
54+
- 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)."
55+
5. {% data reusables.actions.commit-workflow %}
56+
57+
### Testing the workflow
58+
59+
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.
60+
61+
Test your workflow by applying your specified label to an issue.
62+
63+
1. Open an issue in your repository. For more information, see "[Creating an issue](/github/managing-your-work-on-github/creating-an-issue)."
64+
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)."
65+
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)."
66+
4. When the workflow completes, the issue that you labeled should have a comment added.
67+
68+
### Next steps
69+
70+
- 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).

0 commit comments

Comments
 (0)