From 477ab52c620914e052c4be89522d1aa09e831044 Mon Sep 17 00:00:00 2001 From: Lishen Yao Date: Fri, 25 Mar 2022 15:19:21 +0800 Subject: [PATCH] [CI] Add doc bot (#252) * [workflow] Add a pull request template * [CI] Add doc bot --- .github/PULL_REQUEST_TEMPLATE.md | 69 +++++++++++++++++++++++++++++++ .github/workflows/documentbot.yml | 51 +++++++++++++++++++++++ 2 files changed, 120 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/workflows/documentbot.yml diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..b6ae3502 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,69 @@ + + + +*(If this PR fixes a github issue, please add `Fixes #`.)* + +Fixes # + +*(or if this PR is one task of a github issue, please add `Master Issue: #` to link to the master issue.)* + +Master Issue: # + +### Motivation + +*Explain here the context, and why you're making that change. What is the problem you're trying to solve.* + +### Modifications + +*Describe the modifications you've done.* + +### Verifying this change + +- [ ] Make sure that the change passes the CI checks. + +*(Please pick either of the following options)* + +This change is a trivial rework / code cleanup without any test coverage. + +*(or)* + +This change is already covered by existing tests, such as *(please describe tests)*. + +*(or)* + +This change added tests and can be verified as follows: + +*(example:)* + - *Added integration tests for end-to-end deployment with large payloads (10MB)* + - *Extended integration test for recovery after broker failure* + +### Documentation + +Check the box below. + +Need to update docs? + +- [ ] `doc-required` + + (If you need help on updating docs, create a doc issue) + +- [ ] `no-need-doc` + + (Please explain why) + +- [ ] `doc` + + (If this PR contains doc changes) + diff --git a/.github/workflows/documentbot.yml b/.github/workflows/documentbot.yml new file mode 100644 index 00000000..852a588f --- /dev/null +++ b/.github/workflows/documentbot.yml @@ -0,0 +1,51 @@ + +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# + +name: Auto Labeling + +on: + pull_request_target : + types: + - opened + - edited + - labeled + + + +# A GitHub token created for a PR coming from a fork doesn't have +# 'admin' or 'write' permission (which is required to add labels) +# To avoid this issue, you can use the `scheduled` event and run +# this action on a certain interval.And check the label about the +# document. + +jobs: + labeling: + if: ${{ github.repository == 'streamnative/pulsar-io-amqp-1-0' }} + permissions: + pull-requests: write + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + + - uses: streamnative/github-workflow-libraries/doc-label-check@master + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + label-pattern: '- \[(.*?)\] ?`(.+?)`' # matches '- [x] `label`' +