Iox #556 release 1.0 preparation

.github/workflows/changelog.yml

@@ -0,0 +1,44 @@
+# This is a workflow that is manually triggered to generate a changelog based on given git tags and branch
+
+name: Generate Changelog
+
+on:
+  workflow_dispatch:
+    inputs:
+      BranchName:
+        description: 'Branch name to generate changelog'
+        required: true
+      UntilTag:
+        description: 'Until tag v[major].[minor].[patch].[dev]'
+        required: true
+      FutureRelease:
+        description: 'Future release version v[major].[minor].[patch].[dev]'
+        required: true
+
+jobs:
+  create-release:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout branch
+      uses: actions/checkout@v2.3.4
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        ref: ${{ github.event.inputs.BranchName }}
+    # Generate changelog
+    - name: Generate Changelog using github-changelog-generator
+      uses: heinrichreimer/github-changelog-generator-action@v2.1.1
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        project: iceoryx
+        user: eclipse-iceoryx
+        releaseBranch: ${{ github.event.inputs.BranchName }}
+        futureRelease: v${{ github.event.inputs.FutureRelease }}
+        dueTag: ${{ github.event.inputs.UntilTag }}
+        pullRequests: False
+        author: False
+        issues: True
+        issuesWoLabels: True
+        stripHeaders: True
+        stripGeneratorNotice: True

.github/workflows/coverage_doc.yml

@@ -24,7 +24,7 @@ jobs:
         # Softwares installed in ubuntu-18.04 instance
         # https://github.com/actions/virtual-environments/blob/master/images/linux/Ubuntu1804-README.md
         run: |
-          sudo apt-get update 
+          sudo apt-get update
           sudo apt-get install -y libacl1-dev libncurses5-dev git cmake build-essential doxygen graphviz texlive-font-utils lcov
           sudo apt-get install -y plantuml texlive-latex-base texlive-latex-extra texlive-latex-recommended texlive-fonts-recommended
 

.github/workflows/release_build_publish.yml

@@ -0,0 +1,77 @@
+# This workflow only runs manually to build an iceoryx release and publish it into an existing Github Release
+
+name: iceoryx build & create release
+
+on:
+  workflow_dispatch:
+    inputs:
+      ReleaseTag:
+        description: 'Git Tag to create v[major].[minor].[patch]'
+        required: true
+
+jobs:
+  build-ubuntu-release:
+    if: github.actor == 'budrus' || github.actor == 'MatthiasKillat' || github.actor == 'mossmaurice' ||
+        github.actor == 'elfenpfiff' || github.actor == 'elboberido' || github.actor == 'marthtz' ||
+        github.actor == 'ariexi' || github.actor == 'ithier' || github.actor == 'dkroenke'
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-18.04]
+    steps:
+      - name: Install iceoryx dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libacl1-dev libncurses5-dev doxygen graphviz texlive-font-utils
+          sudo apt-get install -y plantuml texlive-latex-base texlive-latex-extra texlive-latex-recommended texlive-fonts-recommended
+
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.inputs.ReleaseTag }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build sources
+        run: |
+          $GITHUB_WORKSPACE/tools/iceoryx_build_test.sh build-strict build-all out-of-tree
+
+      - name: Run all tests
+        run: |
+          cd $GITHUB_WORKSPACE/build
+          tools/run_tests.sh all
+
+      - name: Build debian package
+        run: |
+          $GITHUB_WORKSPACE/tools/iceoryx_build_test.sh clean dds-gateway package
+
+      - name: Upload release artifacts
+        uses: actions/upload-artifact@v2
+        with:
+          name: release_artifacts
+          path: ./build_package/iceoryx*.deb
+
+# This job must be put at the end to collect all release assets from the previous jobs
+  release:
+    name: Create Release
+    needs: build-ubuntu-release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download release artifacts
+        uses: actions/download-artifact@v2
+        with:
+          name: release_artifacts
+
+      - name: Create Release
+        id: create_release
+        uses: softprops/action-gh-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.event.inputs.ReleaseTag }}
+          name: Release ${{ github.event.inputs.ReleaseTag }}
+          draft: true
+          prerelease: true
+          files: |
+            ./iceoryx*.deb

CHANGELOG.md

@@ -0,0 +1,171 @@
+# Change Log
+## [v0.90.0](https://github.com/eclipse-iceoryx/iceoryx/tree/v0.90.0) (2020-12-22)
+[Full Changelog](https://github.com/eclipse-iceoryx/iceoryx/compare/v0.17.0...v0.90.0)\
+Pre-Release for new and stable APIs and n:m pub/sub communication
+
+This is a pre-release for our first long-term-support release that is coming soon (will be iceoryx_1.0.0).
+
+We had a major refactoring of the iceoryx communication infrastructure which allows to do n:m communication now and provides a flexible history functionality for late joining subscribers.
+
+This new infrastructure is also made to support request/response communication as a next step [(\#27)](https://github.com/eclipse-iceoryx/iceoryx/issues/27). The C++ API has been completely reworked and a new C API has been added.
+
+We will give the API draft some weeks for finalizing the features and to incorporate feedback from the community. There's an issue in which we collect and discuss the final modifications [(\#408)](https://github.com/eclipse-iceoryx/iceoryx/issues/408).
+
+**Features:**
+- Complete refactoring of publishers and subscribers from shared memory data structures to user APIs, [\#252](https://github.com/eclipse-iceoryx/iceoryx/issues/252)
+- First versions of new APIs for C++ and C [\#252](https://github.com/eclipse-iceoryx/iceoryx/issues/252)
+- n:m publish/subscribe communication now possible [\#25](https://github.com/eclipse-iceoryx/iceoryx/issues/25)
+- First version of a DDS gateway. Cyclone DDS already integrated, FastDDS on it's way [\#64](https://github.com/eclipse-iceoryx/iceoryx/issues/64), [\#65](https://github.com/eclipse-iceoryx/iceoryx/issues/65)
+- New github actions for Mac OS and colcon build [\#175](https://github.com/eclipse-iceoryx/iceoryx/issues/175), [\#276](https://github.com/eclipse-iceoryx/iceoryx/issues/276), [\#328](https://github.com/eclipse-iceoryx/iceoryx/issues/328)
+- Adjustable capacity for the lockfree queue [\#216](https://github.com/eclipse-iceoryx/iceoryx/issues/216)
+- Check the files have a copyright header [\#346](https://github.com/eclipse-iceoryx/iceoryx/issues/346)
+
+**Refactoring:**
+- Refactoring of waitset [\#341](https://github.com/eclipse-iceoryx/iceoryx/issues/341)
+- create multi publisher example [\#394](https://github.com/eclipse-iceoryx/iceoryx/issues/394)
+- Full IceOryx Public API Cheat Sheet [\#283](https://github.com/eclipse-iceoryx/iceoryx/issues/283)
+- Rework build and test steps in iceoryx [\#433](https://github.com/eclipse-iceoryx/iceoryx/issues/433)
+- Extend iceperf example to C API [\#453](https://github.com/eclipse-iceoryx/iceoryx/issues/453)
+- Remove default parameter from PoshRuntime::getInstance() [\#382](https://github.com/eclipse-iceoryx/iceoryx/issues/382)
+- Enable Sanitizer in Debug Build and Unit Tests [\#141](https://github.com/eclipse-iceoryx/iceoryx/issues/141)
+- Minor RouDi cleanups [\#91](https://github.com/eclipse-iceoryx/iceoryx/issues/91)
+- C++14 [\#220](https://github.com/eclipse-iceoryx/iceoryx/issues/220)
+- Replace occurence of std::list by cxx::list [\#221](https://github.com/eclipse-iceoryx/iceoryx/issues/221)
+
+**Fixed bugs:**
+- SegFault in iox-roudi on startup [\#447](https://github.com/eclipse-iceoryx/iceoryx/issues/447)
+- Mocks can cause segfaults/undefined behavior [\#427](https://github.com/eclipse-iceoryx/iceoryx/issues/427)
+- Chunks are lost forever when having an overflow in a variant queue of type FIFO [\#456](https://github.com/eclipse-iceoryx/iceoryx/issues/456)
+- RouDi does not free shared memory properly on x86 Linux [\#324](https://github.com/eclipse-iceoryx/iceoryx/issues/324)
+- WaitSet behavior wrong in `waitAndReturnFulfilledConditions` [\#388](https://github.com/eclipse-iceoryx/iceoryx/issues/388)
+- Incorrect usage of strncpy [\#374](https://github.com/eclipse-iceoryx/iceoryx/issues/374)
+- Global Instantiation of Publisher/Subscriber created core dump [\#327](https://github.com/eclipse-iceoryx/iceoryx/issues/327)
+
+## [v0.17.0](https://github.com/eclipse-iceoryx/iceoryx/tree/ICEORYX_0.17.0) (2020-08-27)
+[Full Changelog](https://github.com/eclipse-iceoryx/iceoryx/compare/ICEORYX_0.17.0_RC6...v0.17.0)\
+MacOS support and preparations for new API
+
+**Packages:**
+- iceoryx_posh (Quality level 4)
+- iceoryx_utils (Quality level 4)
+- iceoryx_examples (Quality level 5)
+
+**Features:**
+- MacOS support [\#32](https://github.com/eclipse-iceoryx/iceoryx/issues/32)
+- Major RouDi refactorings [\#70](https://github.com/eclipse-iceoryx/iceoryx/issues/70), [\#59](https://github.com/eclipse-iceoryx/iceoryx/issues/59), [\#78](https://github.com/eclipse-iceoryx/iceoryx/issues/78)
+- Preparations for new iceoryx API [\#25](https://github.com/eclipse-iceoryx/iceoryx/issues/25)
+- iceoryx to cyclonedds gateway [\#64](https://github.com/eclipse-iceoryx/iceoryx/issues/64)
+- Introduce cxx::function_ref [\#86](https://github.com/eclipse-iceoryx/iceoryx/issues/86)
+
+**Fixed bugs:**
+- POSIX timer improvements [\#120](https://github.com/eclipse-iceoryx/iceoryx/issues/120), [\#167](https://github.com/eclipse-iceoryx/iceoryx/issues/167)
+- Memory Synchronisation Issue in FiFo [\#119](https://github.com/eclipse-iceoryx/iceoryx/issues/119)
+- Roudi MessageQueue thread startup [\#171](https://github.com/eclipse-iceoryx/iceoryx/issues/171)
+- Destructor fix MessageQueue and UnixDomainSocket [\#150](https://github.com/eclipse-iceoryx/iceoryx/issues/150)
+- RouDi ressource clean-up [\#113](https://github.com/eclipse-iceoryx/iceoryx/issues/113)
+
+## [v0.17.0_RC6](https://github.com/eclipse-iceoryx/iceoryx/tree/ICEORYX_0.17.0_RC6) (2020-07-29)
+[Full Changelog](https://github.com/eclipse-iceoryx/iceoryx/compare/ICEORYX_0.17.0_RC5...ICEORYX_0.17.0_RC6)\
+Release Candidate for 0.17.0 release
+
+**Fixed bugs:**
+- Sporadic timing test failure [\#120](https://github.com/eclipse-iceoryx/iceoryx/issues/120)
+- Improvement: Merge Mempool Introspection data into one sample [\#210](https://github.com/eclipse-iceoryx/iceoryx/issues/210)
+
+## [v0.17.0_RC5](https://github.com/eclipse-iceoryx/iceoryx/tree/ICEORYX_0.17.0_RC5) (2020-07-29)
+[Full Changelog](https://github.com/eclipse-iceoryx/iceoryx/compare/ICEORYX_0.17.0_RC4...ICEORYX_0.17.0_RC5)\
+Release Candidate for 0.17.0 release
+
+**Fixed bugs:**
+- Callable can outrun periodicity of POSIX timer [\#161](https://github.com/eclipse-iceoryx/iceoryx/issues/161)
+
+## [v0.17.0_RC4](https://github.com/eclipse-iceoryx/iceoryx/tree/ICEORYX_0.17.0_RC4) (2020-07-29)
+[Full Changelog](https://github.com/eclipse-iceoryx/iceoryx/compare/ICEORYX_0.17.0_RC3...ICEORYX_0.17.0_RC4)\
+Release Candidate for 0.17.0 release
+
+**Fixed bugs:**
+- The destroy method of MessageQueue and UnixDomainSocket does not fully invalidate the object [\#150](https://github.com/eclipse-iceoryx/iceoryx/issues/150)
+- Roudi message queue thread startup [\#171](https://github.com/eclipse-iceoryx/iceoryx/issues/171)
+
+## [v0.17.0_RC3](https://github.com/eclipse-iceoryx/iceoryx/tree/ICEORYX_0.17.0_RC3) (2020-07-27)
+[Full Changelog](https://github.com/eclipse-iceoryx/iceoryx/compare/ICEORYX_0.17.0_RC2...ICEORYX_0.17.0_RC3)\
+Release Candidate for 0.17.0 release
+
+**Features:**
+- cmake options for deployment parameter [\#142](https://github.com/eclipse-iceoryx/iceoryx/issues/142)
+
+## [v0.17.0_RC2](https://github.com/eclipse-iceoryx/iceoryx/tree/ICEORYX_0.17.0_RC2) (2020-07-27)
+[Full Changelog](https://github.com/eclipse-iceoryx/iceoryx/compare/ICEORYX_0.17.0_RC1...ICEORYX_0.17.0_RC2)\
+Release Candidate for 0.17.0 release
+
+**Refactoring:**
+- Refactoring of logging [\#88](https://github.com/eclipse-iceoryx/iceoryx/issues/88)
+- Remove const_cast wherever possible [\#76](https://github.com/eclipse-iceoryx/iceoryx/issues/76)
+- Remove asynchronous service discovery feature [\#90](https://github.com/eclipse-iceoryx/iceoryx/issues/90)
+- qacpp-4.5.0-2427 [\#93](https://github.com/eclipse-iceoryx/iceoryx/issues/93)
+- Usage of github actions to build pull requests [\#89](https://github.com/eclipse-iceoryx/iceoryx/issues/89)
+- Reduce default memory consumption with config and mempools [\#78](https://github.com/eclipse-iceoryx/iceoryx/issues/78)
+
+**Fixed bugs:**
+- Sporadic timing test failure [\#120](https://github.com/eclipse-iceoryx/iceoryx/issues/120)
+- Make SOFI real size equal to the specified one [\#105](https://github.com/eclipse-iceoryx/iceoryx/issues/105)
+- increase padding in introspection [\#117](https://github.com/eclipse-iceoryx/iceoryx/issues/117)
+- Increase the process waiting for RouDi timeout to 60 seconds [\#110](https://github.com/eclipse-iceoryx/iceoryx/issues/110)
+
+## [v0.17.0_RC1](https://github.com/eclipse-iceoryx/iceoryx/tree/ICEORYX_0.17.0_RC1) (2020-03-24)
+[Full Changelog](https://github.com/eclipse-iceoryx/iceoryx/compare/v0.16.1...ICEORYX_0.17.0_RC1)\
+Release Candidate for 0.17.0 release
+
+**Features:**
+- Memory abstraction, modularization of RouDi and fixes [\#59](https://github.com/eclipse-iceoryx/iceoryx/issues/59)
+- Memory abstraction and RouDi modularization step 2, fixed string improvements and other fixes [\#70](https://github.com/eclipse-iceoryx/iceoryx/issues/70)
+
+**Fixed bugs:**
+- Can't compile due to missing CPPTOML [\#67](https://github.com/eclipse-iceoryx/iceoryx/issues/67)
+
+
+## [v0.16.1](https://github.com/eclipse-iceoryx/iceoryx/tree/v0.16.1) (2020-03-02)
+[Full Changelog](https://github.com/eclipse-iceoryx/iceoryx/compare/v0.16.0...v0.16.1)\
+Support for rmw_iceoryx with ROS2 python API
+
+**Packages:**
+
+- POSH (POSIX Shared Memory)
+- Utils
+- Iceoryx examples
+
+**Features:**
+
+- Capability to cleanup shared memory resources during process lifetime [\#51](https://github.com/eclipse-iceoryx/iceoryx/issues/51)
+
+**Fixed bugs:**
+- compile error with clang [\#43](https://github.com/eclipse-iceoryx/iceoryx/issues/43)
+- CMqInterface unit tests are failing caused by unneeded move operations [\#56](https://github.com/eclipse-iceoryx/iceoryx/issues/56)
+
+**Known limitations:**
+- ```RouDi --version``` shows 0.16.0.1 instead of 0.16.1
+
+## [v0.16.0](https://github.com/eclipse-iceoryx/iceoryx/tree/v0.16.0) (2019-12-16)
+Introspection, performance test and flexible mapping of shared memory
+
+**Packages:**
+
+- POSH (POSIX Shared Memory)
+- Utils
+- Iceoryx examples
+
+**Features:**
+
+- Introspection client for live debugging of iceoryx [\#21](https://github.com/eclipse-iceoryx/iceoryx/issues/21)
+- Flexible mapping of shared memory in virtual address spaces [\#19](https://github.com/eclipse-iceoryx/iceoryx/issues/19)
+- Performance test to measure inter-process latency [\#17](https://github.com/eclipse-iceoryx/iceoryx/issues/17)
+- Docker build [\#15](https://github.com/eclipse-iceoryx/iceoryx/issues/15) (Thanks to @Mr-Slippery ) 
+
+**Fixed bugs:**
+- Payload size not updated by allocateChunk [\#10](https://github.com/eclipse-iceoryx/iceoryx/issues/10)
+- Failure in runnable creation [\#23](https://github.com/eclipse-iceoryx/iceoryx/issues/23)
+
+Command for generating git log for merge commits between two tags
+```bash
+git log --merges --first-parent master --pretty=format:"%h %<(10,trunc)%aN %C(white)%<(15)%aD%Creset %C(red bold)%<(15)%D%Creset %s" <TAG_BASE>...<TAG_TARGET> > diff_merge_commit.log
+```

CONTRIBUTING.md

@@ -81,7 +81,7 @@ codebase follows these rules, things are work in progress.
 7) **Always use `iox::log::Logger`**, instead of `printf()`
 8) **Always use `iox::ErrorHandler()`**, instead of the direct STL calls
 
-See [error-handling.md](./doc/error-handling.md) for additional information about logging and error handling. 
+See [error-handling.md](./doc/error-handling.md) for additional information about logging and error handling.
 
 ### Naming conventions
 

NOTICE.md

@@ -28,12 +28,53 @@ The project maintains the following source code repositories:
 
 * https://github.com/eclipse-iceoryx/iceoryx
 
-## Third-party Content
+## Third-party Dependencies
 
 This project leverages the following third party content.
-
-None
-
+The corresponding license files can be found at https://github.com/eclipse-iceoryx/iceoryx/tree/master/doc/3rd_party_licenses or in the folder `share/doc/iceoryx/3rd_party_licenses` of your local iceoryx installation.
+
+### System Libraries
+libacl library
+ * Usage: as-is, dynamic-linking
+ * Notes: system-header `<sys/acl.h>` is used.
+
+libncurses library
+ * Usage: as-is, dynamic-linking
+ * Notes: system-header `<ncurses.h>` is used.
+
+### Optional Build Dependencies
+cpptoml library (v0.1.1)
+ * License: MIT
+ * Project: https://github.com/skystrife/cpptoml
+ * Source: https://github.com/skystrife/cpptoml/tree/v0.1.1
+ * Usage: as-is, static-linking
+ * enabled by default build
+
+Eclipse Cyclone DDS (0.7.0)
+ * License: Eclipse Public License v. 2.0 or the Eclipse Distribution License v. 1.0
+ * Project: https://github.com/eclipse-cyclonedds/cyclonedds
+ * Source: https://github.com/eclipse-cyclonedds/cyclonedds/tree/0.7.0
+ * Usage: as-is, static-linking
+
+C++ binding for Eclipse Cyclone DDS (Git Commit a7285c9d10d2da223d5a2fb8c9c04e591bcb3627)
+ * License: Eclipse Public License v. 2.0 or the Eclipse Distribution License v. 1.0
+ * Project: https://github.com/eclipse-cyclonedds/cyclonedds-cxx
+ * Source: https://github.com/eclipse-cyclonedds/cyclonedds-cxx/tree/a7285c9d10d2da223d5a2fb8c9c04e591bcb3627
+ * Usage: as-is, static-linking
+
+CXX Idl compiler for CycloneDDS (idlpp-cxx-1.0.0)
+ * License: Eclipse Public License v. 2.0 or the Eclipse Distribution License v. 1.0
+ * Project: https://github.com/ADLINK-IST/idlpp-cxx
+ * Source: https://github.com/ADLINK-IST/idlpp-cxx/tree/idlpp-cxx-1.0.0
+ * Usage: as-is, static-linking
+
+### Tools used by iceoryx
+
+Google Test (release-1.10.0)
+ * License: BSD 3-Clause "New" or "Revised" License
+ * Project: https://github.com/google/googletest
+ * Source: https://github.com/google/googletest/tree/release-1.10.0
+ * Usage: as-is, static-linking
 ## Cryptography
 
 Content may contain encryption software. The country in which you are currently

README.md

@@ -52,6 +52,7 @@ An example for such a "porcelain" API would be [ROS2](https://www.ros.org/). Oth
 | [eCAL](https://github.com/continental/ecal) | Open-source framework from [Continental AG](https://www.continental.com/) supporting pub/sub and various message protocols |
 | [RTA-VRTE](https://www.etas.com/en/products/rta-vrte.php) | [Adaptive AUTOSAR](https://www.autosar.org/standards/adaptive-platform/) platform software framework for vehicle computer from [ETAS GmbH](https://www.etas.com) |
 | [Cyclone DDS](https://github.com/eclipse-cyclonedds/cyclonedds) | Performant and robust open-source DDS implementation maintained by [ADLINK Technology Inc.](https://www.adlinktech.com/) |
+| [Apex.OS](https://www.apex.ai/apex-os) | Safe and certified software framework for autonomous mobility systems. |
 
 ## Build and install
 

VERSION

@@ -1 +1 @@
-0.90.0.0
+1.0.0.0-rc1