raulcd commented on code in PR #193: URL: https://github.com/apache/iceberg-cpp/pull/193#discussion_r2303304508
########## .github/workflows/rc.yml: ########## @@ -0,0 +1,147 @@ +# 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: RC +on: + push: + tags: + - '*-rc*' + +concurrency: + group: ${{ github.repository }}-${{ github.head_ref || github.sha }}-${{ github.workflow }} + cancel-in-progress: true +permissions: + contents: read + +jobs: + archive: + name: Archive + runs-on: ubuntu-latest + timeout-minutes: 5 # Can be reduced as we are not checking out submodules + steps: + - name: Checkout + uses: actions/checkout@v4 + # No longer need 'with: { submodules: 'recursive' }' + + - name: Prepare for tag + if: github.ref_type == 'tag' + run: | + version=${GITHUB_REF_NAME#v} + version=${version%-rc*} + rc=${GITHUB_REF_NAME##*-rc} + echo "VERSION=${version}" >> ${GITHUB_ENV} + echo "RC=${rc}" >> ${GITHUB_ENV} + echo "VERSION=${version}" + echo "RC=${rc}" + + - name: Archive + run: | + id="apache-iceberg-cpp-${VERSION}-rc${RC}" + tar_gz="${id}.tar.gz" + echo "TAR_GZ=${tar_gz}" >> ${GITHUB_ENV} + # Reverted to the git archive command from the Go implementation + git archive HEAD --prefix "${id}/" --output "${tar_gz}" + sha512sum "${tar_gz}" > "${tar_gz}.sha512" + + - name: Audit + run: | + dev/release/run_rat.sh "${TAR_GZ}" + + - uses: actions/upload-artifact@v4 + with: + name: archive + path: | + apache-iceberg-cpp-* + + verify: + name: Verify + needs: + - archive + runs-on: ${{ matrix.os }} + strategy: + fail-fast: false + matrix: + os: + - macos-latest + - ubuntu-latest + # Consider adding windows-latest if your project supports it + # - windows-latest Review Comment: Is the plan to add windows verification in the future? Maybe on future releases? We probably should update the comment and potentially open an issue to add Windows verification ########## .github/workflows/rc.yml: ########## @@ -0,0 +1,147 @@ +# 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: RC +on: + push: + tags: + - '*-rc*' + +concurrency: + group: ${{ github.repository }}-${{ github.head_ref || github.sha }}-${{ github.workflow }} + cancel-in-progress: true +permissions: + contents: read + +jobs: + archive: + name: Archive + runs-on: ubuntu-latest + timeout-minutes: 5 # Can be reduced as we are not checking out submodules + steps: + - name: Checkout + uses: actions/checkout@v4 + # No longer need 'with: { submodules: 'recursive' }' + + - name: Prepare for tag + if: github.ref_type == 'tag' + run: | + version=${GITHUB_REF_NAME#v} + version=${version%-rc*} + rc=${GITHUB_REF_NAME##*-rc} + echo "VERSION=${version}" >> ${GITHUB_ENV} + echo "RC=${rc}" >> ${GITHUB_ENV} + echo "VERSION=${version}" + echo "RC=${rc}" + + - name: Archive + run: | + id="apache-iceberg-cpp-${VERSION}-rc${RC}" + tar_gz="${id}.tar.gz" + echo "TAR_GZ=${tar_gz}" >> ${GITHUB_ENV} + # Reverted to the git archive command from the Go implementation + git archive HEAD --prefix "${id}/" --output "${tar_gz}" + sha512sum "${tar_gz}" > "${tar_gz}.sha512" + + - name: Audit + run: | + dev/release/run_rat.sh "${TAR_GZ}" + + - uses: actions/upload-artifact@v4 + with: + name: archive + path: | + apache-iceberg-cpp-* + + verify: + name: Verify + needs: + - archive + runs-on: ${{ matrix.os }} + strategy: + fail-fast: false + matrix: + os: + - macos-latest + - ubuntu-latest + # Consider adding windows-latest if your project supports it + # - windows-latest + steps: + - name: Install C++ Build Tools (Ubuntu) + if: runner.os == 'Linux' + run: | + sudo apt-get update + sudo apt-get install -y build-essential cmake ninja-build libssl-dev + + - name: Install C++ Build Tools (macOS) + if: runner.os == 'macOS' + run: | + brew install cmake ninja openssl + + - name: Checkout + uses: actions/checkout@v4 + + - uses: actions/download-artifact@v4 + with: + name: archive + + - name: Verify + run: | + tar_gz=$(echo apache-iceberg-cpp-*.tar.gz) + version=${tar_gz#apache-iceberg-cpp-} + version=${version%.tar.gz} + version=${version%%-rc*} + if [ "${GITHUB_REF_TYPE}" = "tag" ]; then + rc=${GITHUB_REF_NAME##*-rc} + else + rc=100 + fi + echo "VERSION=${version}" + echo "RC=${rc}" + # You MUST create this verify_rc.sh script for C++ + # It should untar, cmake, build, and run tests (ctest) Review Comment: ```suggestion # The verify_rc.sh script will untar and # run cmake, build, tests (ctest) and install ``` ########## .github/workflows/rc.yml: ########## @@ -0,0 +1,147 @@ +# 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: RC +on: + push: + tags: + - '*-rc*' + +concurrency: + group: ${{ github.repository }}-${{ github.head_ref || github.sha }}-${{ github.workflow }} + cancel-in-progress: true +permissions: + contents: read + +jobs: + archive: + name: Archive + runs-on: ubuntu-latest + timeout-minutes: 5 # Can be reduced as we are not checking out submodules + steps: + - name: Checkout + uses: actions/checkout@v4 + # No longer need 'with: { submodules: 'recursive' }' + + - name: Prepare for tag + if: github.ref_type == 'tag' + run: | + version=${GITHUB_REF_NAME#v} + version=${version%-rc*} + rc=${GITHUB_REF_NAME##*-rc} + echo "VERSION=${version}" >> ${GITHUB_ENV} + echo "RC=${rc}" >> ${GITHUB_ENV} + echo "VERSION=${version}" + echo "RC=${rc}" + + - name: Archive + run: | + id="apache-iceberg-cpp-${VERSION}-rc${RC}" + tar_gz="${id}.tar.gz" + echo "TAR_GZ=${tar_gz}" >> ${GITHUB_ENV} + # Reverted to the git archive command from the Go implementation Review Comment: is this comment correct? ########## dev/release/README.md: ########## @@ -0,0 +1,105 @@ +<!-- + ~ 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. +--> + +# Release + +## Overview + + 1. Test the revision to be released + 2. Prepare RC and vote (detailed later) + 3. Publish (detailed later) + +### Prepare RC and vote + +Run `dev/release/release_rc.sh` on a working copy of +`g...@github.com:apache/iceberg-cpp` not from your fork: + +```console +$ git clone g...@github.com:apache/iceberg-cpp.git +$ dev/release/release_rc.sh ${VERSION} ${RC} +(Send a vote email to d...@iceberg.apache.org. + You can use a draft shown by release_rc.sh for the email.) +``` + +Here is an example to release RC1: Review Comment: minor nit, is the plan to start with RC1 or 0? Potentially add the example for the first one (0 on case of Arrow) ########## .github/workflows/rc.yml: ########## @@ -0,0 +1,147 @@ +# 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: RC +on: + push: + tags: + - '*-rc*' + +concurrency: + group: ${{ github.repository }}-${{ github.head_ref || github.sha }}-${{ github.workflow }} + cancel-in-progress: true +permissions: + contents: read + +jobs: + archive: + name: Archive + runs-on: ubuntu-latest + timeout-minutes: 5 # Can be reduced as we are not checking out submodules + steps: + - name: Checkout + uses: actions/checkout@v4 + # No longer need 'with: { submodules: 'recursive' }' + + - name: Prepare for tag + if: github.ref_type == 'tag' + run: | + version=${GITHUB_REF_NAME#v} + version=${version%-rc*} + rc=${GITHUB_REF_NAME##*-rc} + echo "VERSION=${version}" >> ${GITHUB_ENV} + echo "RC=${rc}" >> ${GITHUB_ENV} + echo "VERSION=${version}" + echo "RC=${rc}" + + - name: Archive + run: | + id="apache-iceberg-cpp-${VERSION}-rc${RC}" + tar_gz="${id}.tar.gz" + echo "TAR_GZ=${tar_gz}" >> ${GITHUB_ENV} + # Reverted to the git archive command from the Go implementation + git archive HEAD --prefix "${id}/" --output "${tar_gz}" + sha512sum "${tar_gz}" > "${tar_gz}.sha512" + + - name: Audit + run: | + dev/release/run_rat.sh "${TAR_GZ}" + + - uses: actions/upload-artifact@v4 + with: + name: archive + path: | + apache-iceberg-cpp-* + + verify: + name: Verify + needs: + - archive + runs-on: ${{ matrix.os }} + strategy: + fail-fast: false + matrix: + os: + - macos-latest + - ubuntu-latest + # Consider adding windows-latest if your project supports it + # - windows-latest + steps: + - name: Install C++ Build Tools (Ubuntu) + if: runner.os == 'Linux' + run: | + sudo apt-get update + sudo apt-get install -y build-essential cmake ninja-build libssl-dev + + - name: Install C++ Build Tools (macOS) + if: runner.os == 'macOS' + run: | + brew install cmake ninja openssl + + - name: Checkout + uses: actions/checkout@v4 + + - uses: actions/download-artifact@v4 + with: + name: archive + + - name: Verify + run: | + tar_gz=$(echo apache-iceberg-cpp-*.tar.gz) + version=${tar_gz#apache-iceberg-cpp-} + version=${version%.tar.gz} + version=${version%%-rc*} + if [ "${GITHUB_REF_TYPE}" = "tag" ]; then + rc=${GITHUB_REF_NAME##*-rc} + else + rc=100 + fi + echo "VERSION=${version}" + echo "RC=${rc}" + # You MUST create this verify_rc.sh script for C++ + # It should untar, cmake, build, and run tests (ctest) + dev/release/verify_rc.sh "${version}" "${rc}" Review Comment: I think this will fail as is. Signatures are created via the `release_rc.sh` script once this workflow is finished but we are verifying signatures here, we probably should use `VERIFY_SIGN=0 dev/release/verify_rc.sh "${version}" "${rc}"` as the signatures are not yet created when this is executed. Go suspiciously seems to just do `VERIFY_DEFAULT=0 dev/release/verify_rc.sh "${version}" "${rc}"` which means it won't even test. Probably we should validate the verification is being exercised on the Go repository or open an issue there :) -- 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: issues-unsubscr...@iceberg.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For additional commands, e-mail: issues-h...@iceberg.apache.org