aboutsummaryrefslogtreecommitdiff
path: root/.github/workflows/comment-issue.yml
blob: c6b47efca586714dcad44ef48ac2438689e9ec26 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
name: Comment Issue

on:
  issues:
    types:
      - labeled

jobs:
  add-comment-for-user-interest:
    if: "github.event.label.name == 's: waiting for user interest'"
    runs-on: ubuntu-latest
    permissions:
      issues: write
    steps:
      - name: Add Comment For User Interest
        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
        with:
          script: |
            github.rest.issues.createComment({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
              body: `**Thank you for your feature proposal.**

              We marked it as "waiting for user interest" for now to gather some feedback from our community:

              - If you would like to see this feature be implemented, please react to the description with an up-vote (:+1:).
              - If you have a suggestion or want to point out some special cases that need to be considered, please leave a comment, so we are aware about them.

              We would also like to hear about other community members' use cases for the feature to give us a better understanding of their potential implicit or explicit requirements.

              We will start the implementation based on:

              - the number of votes ( :+1: ) and comments
              - the relevance for the ecosystem
              - availability of alternatives and workarounds
              - and the complexity of the requested feature

              We do this because:

              - There are plenty of languages/countries out there and we would like to ensure that every method can cover all or almost all of them.
              - Every feature we add to faker has "costs" associated to it:
                - initial costs: design, implementation, reviews, documentation
                - running costs: awareness of the feature itself, more complex module structure, increased bundle size, more work during refactors

              ---

              [View more issues which are waiting for user interest](https://github.com/faker-js/faker/issues?q=is%3Aissue+is%3Aopen+label%3A%22s%3A+waiting+for+user+interest%22+)`,
            })

      - name: React to Issue
        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
        with:
          script: |
            github.rest.reactions.createForIssue({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
              content: "+1",
            });