Jefffrey commented on code in PR #11949: URL: https://github.com/apache/arrow-rs/pull/11949#discussion_r4463781869
########## .github/workflows/api_change.yml: ########## @@ -0,0 +1,82 @@ +# 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: API changes + +on: + pull_request: + types: [opened, synchronize, reopened, ready_for_review] + paths: + - '**/*.rs' + - '**/Cargo.toml' + - '**/Cargo.lock' + - rust-toolchain.toml + - .cargo/** + - .github/workflows/api_change.yml + +permissions: + contents: read + +concurrency: + group: ${{ github.repository }}-${{ github.event.pull_request.number }}-${{ github.workflow }} + cancel-in-progress: true + +jobs: + check: + if: '!github.event.pull_request.draft' + name: Detect API changes + runs-on: ubuntu-latest + container: + image: amd64/rust + timeout-minutes: 60 + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 + with: + fetch-depth: 0 + persist-credentials: false + - name: Setup Rust toolchain + uses: ./.github/actions/setup-builder + - name: Install cargo-semver-checks + uses: taiki-e/install-action@a4d3f3f761dcd95cce1b72cb61cb6d1963438177 # v2.87.30 + with: + tool: [email protected] + - name: Compare public APIs with the target commit + id: compare + shell: bash + # The event's base SHA can lag behind the checked-out PR merge commit. + # Its first parent is the exact target commit used for this merge. + # Force detection even if the PR bumps Cargo versions. + run: | + base_sha=$(git rev-parse HEAD^1) + check_api() { + local status=0 + cargo semver-checks check-release --baseline-rev "$base_sha" \ + --release-type minor "$@" || status=$? + case "$status" in + 0) ;; + 100) echo 'breaking=true' >> "$GITHUB_OUTPUT" ;; + *) return "$status" ;; + esac + } + check_api --workspace --exclude parquet --all-features + # With async enabled, 0.51 confuses the sync (&self) and async (&mut self) + # get_row_group_column_bloom_filter methods on identical source. Review Comment: I actually encountered this when running cargo semver checks locally for release prep: - https://github.com/obi1kenobi/cargo-semver-checks/issues/1781 Could be worth leaving a comment here with this issue so hopefully we can resolve this in future if its fixed upstream ########## .github/workflows/api_change.yml: ########## @@ -0,0 +1,82 @@ +# 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: API changes + +on: + pull_request: + types: [opened, synchronize, reopened, ready_for_review] + paths: + - '**/*.rs' + - '**/Cargo.toml' + - '**/Cargo.lock' + - rust-toolchain.toml + - .cargo/** + - .github/workflows/api_change.yml + +permissions: + contents: read + +concurrency: + group: ${{ github.repository }}-${{ github.event.pull_request.number }}-${{ github.workflow }} + cancel-in-progress: true + +jobs: + check: + if: '!github.event.pull_request.draft' + name: Detect API changes + runs-on: ubuntu-latest + container: + image: amd64/rust + timeout-minutes: 60 + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 + with: + fetch-depth: 0 + persist-credentials: false + - name: Setup Rust toolchain + uses: ./.github/actions/setup-builder + - name: Install cargo-semver-checks + uses: taiki-e/install-action@a4d3f3f761dcd95cce1b72cb61cb6d1963438177 # v2.87.30 + with: + tool: [email protected] Review Comment: we probably dont need to pin semver checks here; upgrading `taiki-e` will bring us new versions as they come -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
