Merge pull request #4073 from kunaltyagi/release_2

kunaltyagi · web-flow · commit 9f980d7be11c · 2020-08-07T00:26:02.000+09:00
diff --git a/.ci/azure-pipelines/release.yaml b/.ci/azure-pipelines/release.yaml
@@ -13,12 +13,35 @@ resources:
 - repo: self
 
 variables:
-  dockerHub: "PersonalDockerHub"
-  dockerHubID: "kunaltyagi"
+  dockerHub: "PointCloudLibrary@hub.docker.com"
+  dockerHubID: "pointcloudlibrary"
+  # VERSION and RC need to be provided via the UI
+  # UI priority is the lowest and can't override the file data
+  # RC: 0  # number of pre-release
+  # VERSION: 1.99
 
 stages:
+- stage: Info
+  displayName: "Version"
+  jobs:
+  - job: additional_info
+    displayName: "More Info"
+    pool:
+      vmImage: 'ubuntu-latest'
+    steps:
+    - checkout: self
+      # find the commit hash on a quick non-forced update too
+      fetchDepth: 10
+    - script: |
+        echo "Prev release: $(git tag | sort -rV | head -1 | cut -d- -f 2)"
+        echo "Current release: "$(VERSION)-rc$(RC)
+        if [ -z $VERSION ] || [ -z $RC ]; then
+          echo "Bad version and release candidate number"
+          exit 3
+        fi
+      displayName: "Test for and display version info"
 - stage: Debian
-  dependsOn: []
+  dependsOn: ["Info"]
   jobs:
   - job: BuildDebian
     displayName: "Build Debian Latest"
@@ -41,7 +64,7 @@ stages:
         dockerfile: '$(Build.SourcesDirectory)/.dev/docker/release/Dockerfile'
         tags: "$(tag)"
 - stage: ROS
-  dependsOn: []
+  dependsOn: ["Info"]
   jobs:
   - job: PerceptionPCL
     displayName: "perception_pcl compile"
@@ -80,7 +103,7 @@ stages:
     pool:
       vmImage: 'ubuntu-latest'
     variables:
-      SOURCE_TAR: '$(Build.ArtifactStagingDirectory)/source.tar.gz'
+      PUBLISH_LOCATION: '$(Build.ArtifactStagingDirectory)'
     steps:
     - checkout: self
       # find the commit hash on a quick non-forced update too
@@ -93,40 +116,96 @@ stages:
         workingDirectory: '$(Build.SourcesDirectory)'
         failOnStderr: true
     - task: ArchiveFiles@2
-      displayName: "Create release archive"
+      displayName: "Create release archive (.tar.gz)"
       inputs:
         rootFolderOrFile: '$(Build.SourcesDirectory)'
         includeRootFolder: true
         archiveType: 'tar'
-        archiveFile: '$(SOURCE_TAR)'
+        archiveFile: '$(PUBLISH_LOCATION)/source.tar.gz'
         replaceExistingArchive: true
         verbose: true
+    - task: ArchiveFiles@2
+      displayName: "Create release archive (.zip)"
+      inputs:
+        rootFolderOrFile: '$(Build.SourcesDirectory)'
+        includeRootFolder: true
+        archiveType: 'zip'
+        archiveFile: '$(PUBLISH_LOCATION)/source.zip'
+        replaceExistingArchive: true
+        verbose: true
+    - script: |
+        for file in $(ls "$(PUBLISH_LOCATION)/"); do
+          sha256sum "$(PUBLISH_LOCATION)"/"${file}" >> $(PUBLISH_LOCATION)/sha256_checksums.txt
+          sha512sum "$(PUBLISH_LOCATION)"/"${file}" >> $(PUBLISH_LOCATION)/sha512_checksums.txt
+        done
+        echo "SHA 256 Checksums:"
+        cat $(PUBLISH_LOCATION)/sha256_checksums.txt
+        echo "SHA 512 Checksums:"
+        cat $(PUBLISH_LOCATION)/sha512_checksums.txt
+      displayName: "Generate checksum"
     - task: PublishBuildArtifacts@1
       displayName: "Publish archive"
       inputs:
-        PathtoPublish: '$(SOURCE_TAR)'
-        ArtifactName: 'source.tar.gz'
+        PathtoPublish: '$(PUBLISH_LOCATION)/'
+        ArtifactName: 'source'
         publishLocation: 'Container'
-  - job: documentation
-    displayName: Generate Documentation
-    container:
-      image: pointcloudlibrary/doc
+  - job: changelog
+    displayName: Generate Change Log
     pool:
       vmImage: 'ubuntu-latest'
     variables:
-      BUILD_DIR: '$(Agent.BuildDirectory)/build'
       CHANGELOG: '$(Build.ArtifactStagingDirectory)/changelog.md'
     steps:
-    - checkout: self
-      # find the commit hash on a quick non-forced update too
-      fetchDepth: 10
+    - checkout: none
     - script: |
-        $(Build.SourcesDirectory)/.dev/scripts/generate_changelog.py --with-misc > $(CHANGELOG)
-        pandoc -f markdown -t plain --wrap=none $(CHANGELOG)
+        cat > $(CHANGELOG) <<EOF
+        ## Insert Summary Here
+
+        For an exhaustive list of newly added features, deprecations and other changes
+        in PCL $(VERSION), please see [CHANGES.md](https://github.com/PointCloudLibrary/pcl/blob/master/CHANGES.md). **Remember to edit the URL**
+        EOF
       displayName: 'Generate Changelog'
     - task: PublishBuildArtifacts@1
       displayName: "Publish Changelog"
       inputs:
         PathtoPublish: '$(CHANGELOG)'
-        ArtifactName: 'changelog.md'
+        ArtifactName: 'changelog'
         publishLocation: 'Container'
+- stage: Release
+  dependsOn: ["Prepare"]
+  jobs:
+  - job: release
+    displayName: "Release the kraken"
+    timeoutInMinutes: 360
+    variables:
+      DOWNLOAD_LOCATION: '$(Build.ArtifactStagingDirectory)'
+    pool:
+      vmImage: 'ubuntu-latest'
+    steps:
+    - checkout: self
+      # find the commit hash on a quick non-forced update too
+      fetchDepth: 10
+    - bash: |
+        if [ -z $RC ] || [ $RC -eq 0 ]; then isPreRelease=false; else isPreRelease=true; fi
+        echo "##vso[task.setvariable variable=isPreRelease]${isPreRelease}"
+    - task: DownloadBuildArtifacts@0
+      inputs:
+        downloadType: 'all'  # can be anything except single
+        downloadPath: '$(DOWNLOAD_LOCATION)'
+    - task: GitHubRelease@1
+      inputs:
+        action: 'create'
+        addChangeLog: false
+        # assets, one pattern per line
+        assets: |
+          $(DOWNLOAD_LOCATION)/source/*
+        isDraft: true
+        isPreRelease: $(isPreRelease)
+        gitHubConnection: 'Release to GitHub'
+        releaseNotesFilePath: '$(DOWNLOAD_LOCATION)/changelog/changelog.md'
+        repositoryName: $(Build.Repository.Name)
+        tagSource: 'userSpecifiedTag'
+        tag: "pcl-$(VERSION)-rc$(RC)"
+        tagPattern: 'pcl-*'
+        target: '$(Build.SourceVersion)'
+        title: 'PCL $(VERSION)'
diff --git a/.dev/docker/perception_pcl_ros/Dockerfile b/.dev/docker/perception_pcl_ros/Dockerfile
@@ -19,9 +19,9 @@ RUN sed -i "s/^# deb-src/deb-src/" /etc/apt/sources.list \
  && apt install -y \
     libeigen3-dev \
     libflann-dev \
+    libqhull-dev \
     python-pip \
     ros-${flavor}-tf2-eigen \
- && apt build-dep pcl -y \
  && pip install -U pip \
  && pip install catkin_tools \
  && cd ${workspace}/src \
@@ -34,6 +34,7 @@ COPY package.xml ${workspace}/src/pcl/
 
 RUN cd ${workspace} \
  && . "/opt/ros/${flavor}/setup.sh" \
- && catkin config --install \
+ && catkin config --install --link-devel \
  && catkin build -j2 libpcl-all-dev --cmake-args -DWITH_OPENGL:BOOL=OFF \
- && catkin build
+ && rm -fr build/libpcl-all-dev \
+ && catkin build --start-with pcl_msgs
diff --git a/.dev/docker/perception_pcl_ros/colcon.Dockerfile b/.dev/docker/perception_pcl_ros/colcon.Dockerfile
@@ -0,0 +1,37 @@
+# flavor appears twice, once for the FOR, once for the contents since
+# Dockerfile seems to reset arguments after a FOR appears
+ARG flavor="dashing"
+FROM ros:${flavor}-ros-base
+
+ARG flavor="dashing"
+ARG workspace="/root/catkin_ws"
+
+COPY ${flavor}_rosinstall.yaml ${workspace}/src/.rosinstall
+
+# Be careful:
+# * source ROS setup file in evey RUN snippet
+#
+# TODO: The dependencies of PCL can be reduced since
+# * we don't need to build visualization or docs
+RUN sed -i "s/^# deb-src/deb-src/" /etc/apt/sources.list \
+ && apt update \
+ && apt install -y \
+    libeigen3-dev \
+    libflann-dev \
+    ros-${flavor}-tf2-eigen \
+ && apt build-dep pcl -y \
+ && pip3 install -U pip \
+ && pip3 install wstool \
+ && cd ${workspace}/src \
+ && . "/opt/ros/${flavor}/setup.sh" \
+ && catkin_init_workspace \
+ && cd .. \
+ && wstool update -t src
+
+COPY package.xml ${workspace}/src/pcl/
+
+RUN cd ${workspace} \
+ && . "/opt/ros/${flavor}/setup.sh" \
+ && catkin config --install \
+ && catkin build -j2 libpcl-all-dev --cmake-args -DWITH_OPENGL:BOOL=OFF \
+ && catkin build
diff --git a/.dev/docker/release/Dockerfile b/.dev/docker/release/Dockerfile
@@ -1,5 +1,6 @@
 FROM debian:testing
 
+ARG VTK_VERSION=7
 ENV DEBIAN_FRONTEND=noninteractive
 
 # Add sources so we can just install build-dependencies of PCL
@@ -10,12 +11,30 @@ RUN sed -i 's/^deb \(.*\)$/deb \1\ndeb-src \1/' /etc/apt/sources.list \
     cmake \
     dpkg-dev \
     git \
- && apt build-dep pcl -y \
+    g++ \
+    libboost-date-time-dev \
+    libboost-filesystem-dev \
+    libboost-iostreams-dev \
+    libeigen3-dev \
+    libflann-dev \
+    libglew-dev \
+    libgtest-dev \
+    libopenni-dev \
+    libopenni2-dev \
+    libproj-dev \
+    libqhull-dev \
+    libqt5opengl5-dev \
+    libusb-1.0-0-dev \
+    libvtk${VTK_VERSION}-dev \
+    libvtk${VTK_VERSION}-qt-dev \
+    qtbase5-dev \
+    wget \
  && rm -rf /var/lib/apt/lists/*
 
 # CMake flags are from dpkg helper
 # PCL config is from debian repo:
 # https://salsa.debian.org/science-team/pcl/-/blob/master/debian/rules
+# MinSizeRel is used for the CI and should have no impact on releaseability
 RUN cd \
  && git clone --depth=1 https://github.com/PointCloudLibrary/pcl \
  && mkdir pcl/build \
@@ -24,19 +43,20 @@ RUN cd \
  && export DEB_CFLAGS_MAINT_APPEND="-Wall -pedantic" \
  && export DEB_LDFLAGS_MAINT_APPEND="-Wl,--as-needed" \
  && cmake .. \
-    -DCMAKE_CXX_FLAGS="`dpkg-buildflags --get CXXFLAGS`" \
-    -DCMAKE_EXE_LINKER_FLAGS:STRING="`dpkg-buildflags --get LDFLAGS`" \
+    -DCMAKE_BUILD_TYPE=MinSizeRel \
+    -DCMAKE_CXX_FLAGS:STRING="`dpkg-buildflags --get CXXFLAGS`"          \
+    -DCMAKE_EXE_LINKER_FLAGS:STRING="`dpkg-buildflags --get LDFLAGS`"    \
     -DCMAKE_SHARED_LINKER_FLAGS:STRING="`dpkg-buildflags --get LDFLAGS`" \
-    -DCMAKE_SKIP_RPATH=ON -DPCL_ENABLE_SSE=OFF         \
-    -DBUILD_TESTS=OFF -DBUILD_apps=ON -DBUILD_common=ON     \
-    -DBUILD_examples=ON -DBUILD_features=ON -DBUILD_filters=ON  \
-    -DBUILD_geometry=ON -DBUILD_global_tests=OFF -DBUILD_io=ON  \
-    -DBUILD_kdtree=ON -DBUILD_keypoints=ON -DBUILD_octree=ON    \
-    -DBUILD_registration=ON -DBUILD_sample_consensus=ON     \
-    -DBUILD_search=ON -DBUILD_segmentation=ON -DBUILD_surface=ON    \
-    -DBUILD_tools=ON -DBUILD_tracking=ON -DBUILD_visualization=ON   \
-    -DBUILD_apps_cloud_composer=OFF -DBUILD_apps_modeler=ON            \
-    -DBUILD_apps_point_cloud_editor=ON -DBUILD_apps_in_hand_scanner=ON \
+    -DCMAKE_SKIP_RPATH=ON -DPCL_ENABLE_SSE=OFF                          \
+    -DBUILD_TESTS=OFF -DBUILD_apps=ON -DBUILD_common=ON                 \
+    -DBUILD_examples=ON -DBUILD_features=ON -DBUILD_filters=ON           \
+    -DBUILD_geometry=ON -DBUILD_global_tests=OFF -DBUILD_io=ON          \
+    -DBUILD_kdtree=ON -DBUILD_keypoints=ON -DBUILD_octree=ON            \
+    -DBUILD_registration=ON -DBUILD_sample_consensus=ON                 \
+    -DBUILD_search=ON -DBUILD_segmentation=ON -DBUILD_surface=ON        \
+    -DBUILD_tools=ON -DBUILD_tracking=ON -DBUILD_visualization=ON       \
+    -DBUILD_apps_cloud_composer=OFF -DBUILD_apps_modeler=ON             \
+    -DBUILD_apps_point_cloud_editor=ON -DBUILD_apps_in_hand_scanner=ON  \
  && make install -j2 \
  && cd \
  && rm -fr pcl
diff --git a/.dev/scripts/bump_post_release.bash b/.dev/scripts/bump_post_release.bash
@@ -0,0 +1,11 @@
+#! /usr/bin/env bash
+
+new_version=$(git tag | sort -rV | head -1 | cut -d- -f 2).99
+
+# Mac users either use gsed or add "" after -i
+if ls | grep README -q; then
+    sed -i "s,VERSION [0-9.]*),VERSION ${new_version})," CMakeLists.txt
+else
+    echo "Don't think this is the root directory" 1>&2
+    exit 4
+fi
diff --git a/.dev/scripts/bump_release.bash b/.dev/scripts/bump_release.bash
@@ -0,0 +1,16 @@
+#! /usr/bin/env bash
+
+if [ $# != 1 ]; then
+    echo "Need (only) the release version" 1>&2
+    exit 3
+fi
+
+# Mac users either use gsed or add "" after -i
+new_version="$1"
+if ls | grep README -q; then
+    sed -i "s,[0-9]\+\.[0-9]\+\.[0-9]\+,${new_version}," README.md
+    sed -i "s,VERSION [0-9.]*),VERSION ${new_version})," CMakeLists.txt
+else
+    echo "Don't think this is the root directory" 1>&2
+    exit 4
+fi
diff --git a/.dev/scripts/generate_changelog.py b/.dev/scripts/generate_changelog.py
@@ -46,7 +46,7 @@
 
 
 CATEGORIES = {
-    "new feature": ("New features", ""),
+    "new feature": ("New features", "added to PCL"),
     "deprecation": (
         "Deprecation",
         "of public APIs, scheduled to be removed after two minor releases",
