POC: SHM watchdog

.config/nextest.toml

@@ -1,3 +1,16 @@
+# By default, retry a few times until pass the test within the specified timeout
+[profile.default]
+retries = 4
+slow-timeout = { period = "60s", terminate-after = 2 }
+
+# Run the following tests exclusively with longer timeout
 [[profile.default.overrides]]
-filter = 'test(/zenoh_session_unicast/)'
+filter = """
+test(=zenoh_session_unicast) |
+test(=zenoh_session_multicast) |
+test(=transport_tcp_intermittent) |
+test(=transport_tcp_intermittent_for_lowlatency_transport) |
+test(=three_node_combination)
+"""
 threads-required = 'num-cpus'
+slow-timeout = { period = "60s", terminate-after = 6 }

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,7 +1,6 @@
-name: Report a bug
+name: Bug
 description: |
-  Create a bug report to help us improve Zenoh.
-title: "[Bug] "
+  Report a bug.
 labels: ["bug"]
 body:
   - type: textarea
@@ -19,7 +18,7 @@ body:
     attributes:
       label: To reproduce
       description: "Steps to reproduce the behavior:"
-      placeholder: | 
+      placeholder: |
         1. Start a subscriber "..."
         2. Start a publisher "...."
         3. See error

.github/ISSUE_TEMPLATE/feature_request.yml → .github/ISSUE_TEMPLATE/new_feature.yml

@@ -1,6 +1,7 @@
-name: Request a feature
+name: New feature
 description: |
-  Suggest a new feature specific to this repository. NOTE: for generic Zenoh ideas use "Ask a question".
+  Suggest a new feature.
+labels: ["new feature"]
 body:
   - type: markdown
     attributes:

.github/ISSUE_TEMPLATE/release.yml

@@ -0,0 +1,29 @@
+name: Add an issue to the next release
+description: |
+  Add an issue as part of next release. 
+  This will be added to the current release project. 
+  You must be a contributor to use this template.
+labels: ["release"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **Guidelines for a good issue**
+
+        *Is your release item related to a problem?*
+        A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+        *Describe the solution you'd like*
+        A clear and concise description of what you want to happen.
+
+        *Describe alternatives you've considered*
+        A clear and concise description of any alternative solutions or features you've considered.
+
+        *Additional context*
+        Add any other context about the release item request here.
+  - type: textarea
+    id: item
+    attributes:
+      label: "Describe the release item"
+    validations:
+      required: true

.github/workflows/ci.yml

@@ -21,6 +21,10 @@ on:
   schedule:
     - cron: "0 6 * * 1-5"
 
+env:
+  CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse
+  CARGO_PROFILE_DEV_DEBUG: false
+
 jobs:
   check:
     name: Run checks on ${{ matrix.os }}
@@ -41,31 +45,23 @@ jobs:
 
       - name: Code format check
         run: cargo fmt --check
-        env:
-          CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse
 
       - name: Clippy
-        run: cargo clippy --all-targets -- --deny warnings
-        env:
-          CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse
+        run: cargo +stable clippy --all-targets -- --deny warnings
 
       - name: Clippy unstable targets
-        run: cargo clippy --all-targets --features unstable -- --deny warnings
-        env:
-          CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse
+        run: cargo +stable clippy --all-targets --features unstable -- --deny warnings
 
       - name: Clippy all features
         if: ${{ matrix.os == 'ubuntu-latest' || matrix.os == 'macOS-latest' }}
-        run: cargo clippy --all-targets --all-features -- --deny warnings
+        run: cargo +stable clippy --all-targets --all-features -- --deny warnings
 
       - name: Install generic no_std target
         # Generic no_std target architecture is x86_64-unknown-none
         run: rustup target add x86_64-unknown-none
 
       - name: Perform no_std checks
         run: cargo check --bin nostd_check --target x86_64-unknown-none --manifest-path ci/nostd-check/Cargo.toml
-        env:
-          CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse
 
   test:
     name: Run tests on ${{ matrix.os }}
@@ -95,14 +91,12 @@ jobs:
       - name: Run tests
         run: cargo nextest run --exclude zenoh-examples --exclude zenoh-plugin-example --workspace
         env:
-          CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse
           ASYNC_STD_THREAD_COUNT: 4
 
       - name: Run tests with SHM
         if: ${{ matrix.os == 'ubuntu-latest' }}
         run: cargo nextest run -F shared-memory -F transport_unixpipe -p zenoh-transport
         env:
-          CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse
           ASYNC_STD_THREAD_COUNT: 4
 
       - name: Check for feature leaks
@@ -112,7 +106,6 @@ jobs:
       - name: Run doctests
         run: cargo test --doc
         env:
-          CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse
           ASYNC_STD_THREAD_COUNT: 4
 
   # NOTE: In GitHub repository settings, the "Require status checks to pass

.github/workflows/enforce-linking-issues.yml

@@ -0,0 +1,60 @@
+name: Enforce linking issues
+
+on:
+  pull_request_target:
+    types: [opened, edited, labeled]
+  workflow_call:
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  main:
+    name: Enforce referencing a closing issue
+    runs-on: ubuntu-latest
+    steps:
+      - name: Count closing issue references
+        id: has-closing-issue
+        uses: actions/github-script@v7
+        with:
+          result-encoding: string
+          script: |
+            const query = `query ($owner: String!, $name: String!, $number: Int!) {
+              repository(owner: $owner, name: $name) {
+                pullRequest(number: $number) {
+                  closingIssuesReferences(first: 100) {
+                    totalCount
+                  }
+                }
+              }
+            }`;
+
+            const reply = await github.graphql(query, {
+              owner: context.repo.owner,
+              name: context.repo.repo,
+              number: context.payload.pull_request.number
+            });
+
+            return reply
+              .repository
+              .pullRequest
+              .closingIssuesReferences
+              .totalCount > 0;
+
+      - if: ${{ steps.has-closing-issue.outputs.result != 'true' }}
+        name: Suggest that the contributor link an issue
+        uses: actions/github-script@v7
+        with:
+          github-token: ${{ secrets.BOT_TOKEN_WORKFLOW }}
+          script: |
+            const login = "${{ github.event.pull_request.user.login }}";
+            const syntaxUrl = "https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue";
+            const message = `@${login} If this pull request contains a bugfix or a new feature, then please consider using \`Closes #ISSUE-NUMBER\` [syntax](${syntaxUrl}) to link it to an issue.`
+
+            github.rest.issues.createComment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.payload.pull_request.number,
+              body: message,
+            });