Skip to content

Commit

Permalink
[CI] Add doc bot (#6)
Browse files Browse the repository at this point in the history
* [workflow] Add a pull request template

* [CI] Add doc bot
  • Loading branch information
yaalsn authored Mar 25, 2022
1 parent 57b4561 commit f4832c1
Show file tree
Hide file tree
Showing 2 changed files with 120 additions and 0 deletions.
69 changes: 69 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@

<!--
### Contribution Checklist
- Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review.
- Each pull request should address only one issue, not mix up code from multiple issues.
- Each commit in the pull request has a meaningful commit message
- Once all items of the checklist are addressed, remove the above text and this checklist, leaving only the filled out template below.
**(The sections below can be removed for hotfixes of typos)**
-->

*(If this PR fixes a github issue, please add `Fixes #<xyz>`.)*

Fixes #<xyz>

*(or if this PR is one task of a github issue, please add `Master Issue: #<xyz>` to link to the master issue.)*

Master Issue: #<xyz>

### 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)

51 changes: 51 additions & 0 deletions .github/workflows/documentbot.yml
Original file line number Diff line number Diff line change
@@ -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-template' }}
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`'

0 comments on commit f4832c1

Please sign in to comment.