diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..2ae17814a1 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,7 @@ +## What's Changed + +Please fill in a description of the changes here. + +**This contains breaking changes.** + +Closes #NNN. diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 0000000000..f4a1bc9da3 --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,34 @@ +# 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. + +changelog: + categories: + - title: Breaking Changes + labels: + - breaking-change + + - title: New Features and Enhancements + labels: + - enhancement + + - title: Bug Fixes + labels: + - bug-fix + + - title: Other Changes + labels: + - "*" diff --git a/.github/workflows/dev_pr.js b/.github/workflows/dev_pr.js new file mode 100644 index 0000000000..19fd6e5695 --- /dev/null +++ b/.github/workflows/dev_pr.js @@ -0,0 +1,241 @@ +// 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. + +async function have_comment(github, context, pr_number, tag) { + console.log(`Looking for existing comment on ${pr_number} with substring ${tag}`); + const query = ` +query($owner: String!, $name: String!, $number: Int!, $cursor: String) { + repository(owner: $owner, name: $name) { + pullRequest(number: $number) { + id + comments (after:$cursor, first: 50) { + nodes { + id + body + author { + login + } + } + pageInfo { + endCursor + hasNextPage + } + } + } + } +}`; + const tag_regexp = new RegExp(tag); + + let cursor = null; + let pr_id = null; + while (true) { + const result = await github.graphql(query, { + owner: context.repo.owner, + name: context.repo.repo, + number: pr_number, + cursor, + }); + pr_id = result.repository.pullRequest.id; + cursor = result.repository.pullRequest.comments.pageInfo; + const comments = result.repository.pullRequest.comments.nodes; + + for (const comment of comments) { + console.log(comment); + if (comment.author.login === "github-actions" && + comment.body.match(tag_regexp) !== null) { + console.log("Found existing comment"); + return {pr_id, comment_id: comment.id}; + } + } + + if (!result.repository.pullRequest.comments.hasNextPage || + comments.length === 0) { + break; + } + } + console.log("No existing comment"); + return {pr_id, comment_id: null}; +} + +async function upsert_comment(github, {pr_id, comment_id}, body, visible) { + console.log(`Upsert comment (pr_id=${pr_id}, comment_id=${comment_id}, visible=${visible})`); + if (!visible) { + if (comment_id === null) return; + + const query = ` +mutation makeComment($comment: ID!) { + minimizeComment(input: {subjectId: $comment, classifier: RESOLVED}) { + clientMutationId + } +}`; + await github.graphql(query, { + comment: comment_id, + body, + }); + return; + } + + if (comment_id === null) { + const query = ` +mutation makeComment($pr: ID!, $body: String!) { + addComment(input: {subjectId: $pr, body: $body}) { + clientMutationId + } +}`; + await github.graphql(query, { + pr: pr_id, + body, + }); + } else { + const query = ` +mutation makeComment($comment: ID!, $body: String!) { + unminimizeComment(input: {subjectId: $comment}) { + clientMutationId + } + updateIssueComment(input: {id: $comment, body: $body}) { + clientMutationId + } +}`; + await github.graphql(query, { + comment: comment_id, + body, + }); + } +} + +module.exports = { + check_title_format: function({core, github, context}) { + const title = context.payload.pull_request.title; + if (title.startsWith("MINOR: ")) { + context.log("PR is a minor PR"); + return {"issue": null}; + } + + const match = title.match(/^GH-([0-9]+): .*$/); + if (match === null) { + core.setFailed("Invalid PR title format. Must either be MINOR: or GH-NNN:"); + return {"issue": null}; + } + return {"issue": parseInt(match[1], 10)}; + }, + + apply_labels: async function({core, github, context}) { + const body = (context.payload.pull_request.body || "").split(/\n/g); + var has_breaking = false; + for (const line of body) { + if (line.trim().startsWith("**This contains breaking changes.**")) { + has_breaking = true; + break; + } + } + if (has_breaking) { + console.log("PR has breaking changes"); + await github.rest.issues.addLabels({ + issue_number: context.payload.pull_request.number, + owner: context.repo.owner, + repo: context.repo.repo, + labels: ["breaking-change"], + }); + } else { + console.log("PR has no breaking changes"); + } + }, + + check_labels: async function({core, github, context}) { + const categories = ["bug-fix", "chore", "dependencies", "documentation", "enhancement"]; + const labels = (context.payload.pull_request.labels || []); + const required = new Set(categories); + var found = false; + + for (const label of labels) { + console.log(`Found label ${label.name}`); + if (required.has(label.name)) { + found = true; + break; + } + } + + // Look to see if we left a comment before. + const comment_tag = "label_helper_comment"; + const maybe_comment_id = await have_comment(github, context, context.payload.pull_request.number, comment_tag); + console.log("Found comment?"); + console.log(maybe_comment_id); + const body_text = ` + +Thank you for opening a pull request! + +Please label the PR with one or more of: + +${categories.map(c => `- ${c}`).join("\n")} + +Also, add the 'breaking-change' label if appropriate. + +See [CONTRIBUTING.md](https://github.com/apache/arrow-java/blob/main/CONTRIBUTING.md) for details. +`; + + if (found) { + console.log("PR has appropriate label(s)"); + await upsert_comment(github, maybe_comment_id, body_text, false); + } else { + console.log(body_text); + await upsert_comment(github, maybe_comment_id, body_text, true); + core.setFailed("Missing required labels. See CONTRIBUTING.md"); + } + }, + + check_linked_issue: async function({core, github, context, issue}) { + console.log(issue); + if (issue.issue === null) { + console.log("This is a MINOR PR"); + return; + } + const expected = `https://github.com/apache/arrow-java/issues/${issue.issue}`; + + const query = ` +query($owner: String!, $name: String!, $number: Int!) { + repository(owner: $owner, name: $name) { + pullRequest(number: $number) { + closingIssuesReferences(first: 50) { + edges { + node { + number + } + } + } + } + } +}`; + + const result = await github.graphql(query, { + owner: context.repo.owner, + name: context.repo.repo, + number: context.payload.pull_request.number, + }); + const issues = result.repository.pullRequest.closingIssuesReferences.edges; + console.log(issues); + + for (const link of issues) { + console.log(`PR is linked to ${link.node.number}`); + if (link.node.number === issue.issue) { + console.log(`Found link to ${expected}`); + return; + } + } + console.log(`Did not find link to ${expected}`); + core.setFailed("Missing link to issue in title"); + }, +}; diff --git a/.github/workflows/dev_pr.yml b/.github/workflows/dev_pr.yml new file mode 100644 index 0000000000..8da3ab5fd5 --- /dev/null +++ b/.github/workflows/dev_pr.yml @@ -0,0 +1,77 @@ +# 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: Dev PR + +on: + pull_request_target: + types: + - labeled + - unlabeled + - opened + - edited + - reopened + - synchronize + - ready_for_review + - review_requested + +concurrency: + group: ${{ github.repository }}-${{ github.ref }}-${{ github.workflow }} + cancel-in-progress: true + +permissions: + contents: read + pull-requests: write + +jobs: + pr-label: + name: "Ensure PR format" + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + fetch-depth: 0 + persist-credentials: false + + - name: Ensure PR title format + id: title-format + uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1 + with: + script: | + const scripts = require(`${process.env.GITHUB_WORKSPACE}/.github/workflows/dev_pr.js`); + return scripts.check_title_format({core, github, context}); + + - name: Label PR + uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1 + with: + script: | + const scripts = require(`${process.env.GITHUB_WORKSPACE}/.github/workflows/dev_pr.js`); + await scripts.apply_labels({core, github, context}); + + - name: Ensure PR is labeled + uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1 + with: + script: | + const scripts = require(`${process.env.GITHUB_WORKSPACE}/.github/workflows/dev_pr.js`); + await scripts.check_labels({core, github, context}); + + - name: Ensure PR is linked to an issue + uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1 + with: + script: | + const scripts = require(`${process.env.GITHUB_WORKSPACE}/.github/workflows/dev_pr.js`); + await scripts.check_linked_issue({core, github, context, issue: ${{ steps.title-format.outputs.result }}}); diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8388b1d6c7..680750070f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,8 +30,36 @@ existing Arrow issues in [GitHub](https://github.com/apache/arrow-java/issues). ## Did you write a patch that fixes a bug or brings an improvement? -Create a GitHub issue and submit your changes as a GitHub Pull Request. -Please make sure to [reference the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) in your PR description. +- Create a GitHub issue and submit your changes as a GitHub Pull Request. +- [Reference the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) in your PR description. +- Add one or more of the labels "bug-fix", "chore", "dependencies", "documentation", and "enhancement" to your PR as appropriate. + - "bug-fix" is for PRs that fix a bug. + - "chore" is for other administrative work (build system, release process, etc.). + - "dependencies" is for PRs that upgrade a dependency. (Usually only used by dependabot.) + - "documentation" is for documentation updates. + - "enhancement" is for PRs that add new features. +- Add the "breaking-change" label to your PR if there are breaking API changes. +- Add the PR title. The PR title will be used as the eventual commit message, so please make it descriptive but succinct. + +Example #1: + +``` +GH-12345: Document the pull request process + +Explain how to open a pull request and what the title, body, and labels should be. + +Closes #12345. +``` + +Example #2: + +``` +GH-42424: Expose Netty server builder in Flight + +Allow direct usage of gRPC APIs for low-level control. + +Closes #42424. +``` ### Minor Fixes diff --git a/dev/release/rat_exclude_files.txt b/dev/release/rat_exclude_files.txt index 8324d32cf6..0999f1a275 100644 --- a/dev/release/rat_exclude_files.txt +++ b/dev/release/rat_exclude_files.txt @@ -16,5 +16,6 @@ # under the License. .gitmodules +.github/pull_request_template.md dataset/src/test/resources/data/student.csv docs/Makefile