Merge branch 'master' into process-improvement-v0.18.0

.circleci/main.yml

@@ -309,7 +309,7 @@ jobs:
       - run:
           name: Cloning
           command: |
-            git clone https://github.com/ipfs/go-ipfs-http-client.git
+            git clone https://github.com/ipfs/go-ipfs-http-client.git -b bump-for-rcmgr-last-push
             git -C go-ipfs-http-client log -1
       - restore_cache:
           keys:

.github/workflows/build.yml

@@ -14,6 +14,7 @@ jobs:
   prepare:
     if: github.repository == 'ipfs/kubo' || github.event_name == 'workflow_dispatch'
     runs-on: ubuntu-latest
+    timeout-minutes: 5
     env:
       TEST_NO_DOCKER: 1
       TEST_NO_FUSE: 1
@@ -40,12 +41,7 @@ jobs:
   ipfs-interop:
     needs: [prepare]
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        suites:
-          - 'exchange-files'
-          - 'files pin circuit ipns cid-version-agnostic ipns-pubsub pubsub'
-      fail-fast: false
+    timeout-minutes: 20
     defaults:
       run:
         shell: bash
@@ -74,7 +70,7 @@ jobs:
           npm install kubo-rpc-client@^3.0.1
           npm install ipfs-interop@^10.0.1
         working-directory: interop
-      - run: npx ipfs-interop -- -t node $(sed -e 's#[^ ]*#-f test/&.js#g' <<< '${{ matrix.suites }}')
+      - run: npx ipfs-interop -- -t node
         env:
           LIBP2P_TCP_REUSEPORT: false
           LIBP2P_ALLOW_WEAK_RSA_KEYS: 1
@@ -83,6 +79,7 @@ jobs:
   go-ipfs-api:
     needs: [prepare]
     runs-on: ubuntu-latest
+    timeout-minutes: 5
     env:
       TEST_NO_DOCKER: 1
       TEST_NO_FUSE: 1
@@ -122,6 +119,7 @@ jobs:
   go-ipfs-http-client:
     needs: [prepare]
     runs-on: ubuntu-latest
+    timeout-minutes: 5
     env:
       TEST_NO_DOCKER: 1
       TEST_NO_FUSE: 1
@@ -145,6 +143,7 @@ jobs:
         with:
           repository: ipfs/go-ipfs-http-client
           path: go-ipfs-http-client
+          ref: bump-for-rcmgr-last-push
       - uses: protocol/cache-go-action@v1
         with:
           name: ${{ github.job }}
@@ -154,6 +153,7 @@ jobs:
   ipfs-webui:
     needs: [prepare]
     runs-on: ubuntu-latest
+    timeout-minutes: 20
     env:
       NO_SANDBOX: true
       LIBP2P_TCP_REUSEPORT: false

.github/workflows/codeql-analysis.yml

@@ -11,11 +11,16 @@ on:
   schedule:
     - cron: '30 12 * * 2'
 
+permissions:
+  contents: read  #  to fetch code (actions/checkout)
+  security-events: write  #   (github/codeql-action/autobuild)
+
 jobs:
   analyze:
     if: github.repository == 'ipfs/kubo' || github.event_name == 'workflow_dispatch'
     name: Analyze
     runs-on: ubuntu-latest
+    timeout-minutes: 20
 
     strategy:
       fail-fast: false

.github/workflows/docker-build.yml

@@ -11,6 +11,7 @@ jobs:
   docker-build:
     if: github.repository == 'ipfs/kubo' || github.event_name == 'workflow_dispatch'
     runs-on: ubuntu-latest
+    timeout-minutes: 10
     env:
       IMAGE_NAME: ipfs/kubo
       WIP_IMAGE_TAG: wip

.github/workflows/docker-image.yml

@@ -9,11 +9,15 @@ on:
     tags:
       - 'v*'
 
+permissions:
+  contents: read  #  to fetch code (actions/checkout)
+
 jobs:
   push_to_registry:
     if: github.repository == 'ipfs/kubo' || github.event_name == 'workflow_dispatch'
     name: Push Docker image to Docker Hub
     runs-on: ubuntu-latest
+    timeout-minutes: 90
     env:
       IMAGE_NAME: ipfs/kubo
       LEGACY_IMAGE_NAME: ipfs/go-ipfs

.github/workflows/gobuild.yml

@@ -14,6 +14,7 @@ jobs:
   gobuild:
     needs: [runner]
     runs-on: ${{ fromJSON(needs.runner.outputs.config).labels }}
+    timeout-minutes: 20
     env:
       TEST_NO_DOCKER: 1
       TEST_VERBOSE: 1

.github/workflows/golang-analysis.yml

@@ -7,10 +7,14 @@ on:
     branches:
       - 'master'
 
+permissions:
+  contents: read  #  to fetch code (actions/checkout)
+
 jobs:
   unit:
     if: github.repository == 'ipfs/kubo' || github.event_name == 'workflow_dispatch'
     runs-on: ubuntu-latest
+    timeout-minutes: 10
     name: All
     steps:
       - uses: actions/checkout@v2

.github/workflows/golint.yml

@@ -11,6 +11,7 @@ jobs:
   golint:
     if: github.repository == 'ipfs/kubo' || github.event_name == 'workflow_dispatch'
     runs-on: ubuntu-latest
+    timeout-minutes: 10
     env:
       TEST_NO_DOCKER: 1
       TEST_NO_FUSE: 1

.github/workflows/gotest.yml

@@ -11,6 +11,7 @@ jobs:
   gotest:
     if: github.repository == 'ipfs/kubo' || github.event_name == 'workflow_dispatch'
     runs-on: ubuntu-latest
+    timeout-minutes: 20
     env:
       TEST_NO_DOCKER: 1
       TEST_NO_FUSE: 1
@@ -22,22 +23,28 @@ jobs:
       run:
         shell: bash
     steps:
-      - uses: actions/setup-go@v3
+      - name: Set up Go
+        uses: actions/setup-go@v3
         with:
           go-version: 1.19.1
-      - uses: actions/checkout@v3
-      - uses: protocol/cache-go-action@v1
+      - name: Check out Kubo
+        uses: actions/checkout@v3
+      - name: Restore Go cache
+        uses: protocol/cache-go-action@v1
         with:
           name: ${{ github.job }}
-      - run: |
+      - name: 👉️ If this step failed, go to «Summary» (top left) → inspect the «Failures/Errors» table
+        run: |
           make -j 1 test/unit/gotest.junit.xml &&
             [[ ! $(jq -s -c 'map(select(.Action == "fail")) | .[]' test/unit/gotest.json) ]]
-      - uses: codecov/codecov-action@81cd2dc8148241f03f5839d295e000b8f761e378 # v3.1.0
-        if: always()
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@81cd2dc8148241f03f5839d295e000b8f761e378 # v3.1.0
+        if: failure() || success()
         with:
           name: unittests
           files: coverage/unit_tests.coverprofile
-      - run: |
+      - name: Test kubo-as-a-library example
+        run: |
           # we want to first test with the kubo version in the go.mod file
           go test -v ./...
 
@@ -58,8 +65,38 @@ jobs:
           mv go.mod.bak go.mod
           mv go.sum.bak go.sum
         working-directory: docs/examples/kubo-as-a-library
-      - uses: actions/upload-artifact@v3
+      - name: Create a proper JUnit XML report
+        uses: pl-strflt/gotest-json-to-junit-xml@v1
+        with:
+          input: test/unit/gotest.json
+          output: test/unit/gotest.junit.xml
+        if: failure() || success()
+      - name: Archive the JUnit XML report
+        uses: actions/upload-artifact@v3
         with:
           name: unit
           path: test/unit/gotest.junit.xml
-        if: always()
+        if: failure() || success()
+      - name: Create a HTML report
+        uses: pl-strflt/junit-xml-to-html@v1
+        with:
+          mode: no-frames
+          input: test/unit/gotest.junit.xml
+          output: test/unit/gotest.html
+        if: failure() || success()
+      - name: Archive the HTML report
+        uses: actions/upload-artifact@v3
+        with:
+          name: html
+          path: test/unit/gotest.html
+        if: failure() || success()
+      - name: Create a Markdown report
+        uses: pl-strflt/junit-xml-to-html@v1
+        with:
+          mode: summary
+          input: test/unit/gotest.junit.xml
+          output: test/unit/gotest.md
+        if: failure() || success()
+      - name: Set the summary
+        run: cat test/unit/gotest.md >> $GITHUB_STEP_SUMMARY
+        if: failure() || success()

.github/workflows/runner.yml

@@ -10,6 +10,7 @@ on:
 jobs:
   choose:
     runs-on: ubuntu-latest
+    timeout-minutes: 1
     outputs:
       config: ${{ steps.config.outputs.result }}
     steps:

.github/workflows/sharness.yml

@@ -14,6 +14,7 @@ jobs:
   sharness:
     needs: [runner]
     runs-on: ${{ fromJSON(needs.runner.outputs.config).labels }}
+    timeout-minutes: 20
     defaults:
       run:
         shell: bash
@@ -55,9 +56,7 @@ jobs:
           make -O -j "$PARALLEL" \
             test_sharness \
             coverage/sharness_tests.coverprofile \
-            test/sharness/test-results/sharness.xml \
-            test/sharness/test-results/sharness.html \
-            test/sharness/test-results/sharness-html
+            test/sharness/test-results/sharness.xml
         working-directory: kubo
         env:
           TEST_NO_DOCKER: 0
@@ -87,6 +86,13 @@ jobs:
           echo "# Summary" >> $GITHUB_STEP_SUMMARY
           echo >> $GITHUB_STEP_SUMMARY
           cat kubo/test/sharness/test-results/summary.txt >> $GITHUB_STEP_SUMMARY
+      - name: Generate one-page HTML report
+        uses: pl-strflt/junit-xml-to-html@v1
+        if: failure() || success()
+        with:
+          mode: no-frames
+          input: kubo/test/sharness/test-results/sharness.xml
+          output: kubo/test/sharness/test-results/sharness.html
       - name: Upload one-page HTML report to S3
         id: one-page
         uses: pl-strflt/tf-aws-gh-runner/.github/actions/upload-artifact@main
@@ -100,6 +106,13 @@ jobs:
         with:
           name: sharness.html
           path: kubo/test/sharness/test-results/sharness.html
+      - name: Generate full HTML report
+        uses: pl-strflt/junit-xml-to-html@v1
+        if: failure() || success()
+        with:
+          mode: frames
+          input: kubo/test/sharness/test-results/sharness.xml
+          output: kubo/test/sharness/test-results/sharness-html
       - name: Upload full HTML report to S3
         id: full
         uses: pl-strflt/tf-aws-gh-runner/.github/actions/upload-artifact@main

.github/workflows/sync-release-assets.yml

@@ -9,10 +9,14 @@ concurrency:
   group: release-assets-dist-sync
   cancel-in-progress: true
 
+permissions:
+  contents: write  #  to upload release asset
+
 jobs:
   sync-github-and-dist-ipfs-tech:
     if: github.repository == 'ipfs/kubo' || github.event_name == 'workflow_dispatch'
     runs-on: "ubuntu-latest"
+    timeout-minutes: 5
     steps:
       - uses: ipfs/download-ipfs-distribution-action@v1
       - uses: ipfs/start-ipfs-daemon-action@v1

CHANGELOG.md

@@ -1,5 +1,6 @@
 # Kubo Changelogs
 
+- [v0.20](docs/changelogs/v0.20.md)
 - [v0.19](docs/changelogs/v0.19.md)
 - [v0.18](docs/changelogs/v0.18.md)
 - [v0.17](docs/changelogs/v0.17.md)

README.md

@@ -12,7 +12,7 @@ Kubo was the first IPFS implementation and is the most widely used one today. Im
 Featureset
 - Runs an IPFS-Node as a network service
 - [Command Line Interface](https://docs.ipfs.tech/reference/kubo/cli/) to IPFS-Nodes
-- Local [Web2-to-Web3 HTTP Gateway functionality](https://github.com/ipfs/specs/tree/main/http-gateways#readme) 
+- Local [Web2-to-Web3 HTTP Gateway functionality](https://github.com/ipfs/specs/tree/main/http-gateways#readme)
 - HTTP RPC API (`/api/v0`) to access and control the daemon
 - IPFS's internal Webgui can be used to manage the Kubo nodes
 
@@ -381,7 +381,6 @@ Some places to get you started on the codebase:
 - libp2p
   - libp2p: https://github.com/libp2p/go-libp2p
   - DHT: https://github.com/libp2p/go-libp2p-kad-dht
-  - PubSub: https://github.com/libp2p/go-libp2p-pubsub
 - [IPFS : The `Add` command demystified](https://github.com/ipfs/kubo/tree/master/docs/add-code-flow.md)
 
 ### Map of Implemented Subsystems

Rules.mk

@@ -118,7 +118,7 @@ help:
 	@echo '  all          - print this help message'
 	@echo '  build        - Build binary at ./cmd/ipfs/ipfs'
 	@echo '  nofuse       - Build binary with no fuse support'
-	@echo '  install      - Build binary and install into $$GOPATH/bin'
+	@echo '  install      - Build binary and install into $$GOBIN'
 #	@echo '  dist_install - TODO: c.f. ./cmd/ipfs/dist/README.md'
 	@echo ''
 	@echo 'CLEANING TARGETS:'