Merge branch 'main' into main

Author: awrichar

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,62 @@
+name: 🐞 Bug
+description: File a bug/issue
+title: "bug: "
+labels: [bug]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        _The more information you share, the faster we can help you._
+        Prior to opening the issue, please make sure that you:
+        - Use English (EN/US) to communicate.
+        - Search the [open issues](https://github.com/hyperledger/firefly/issues) to avoid duplicating the issue.
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: What happened?
+      description: |
+        Please provide as much info as possible. Not doing so may result in your bug not being addressed in a timely manner.
+        If this matter is security related, please disclose it privately via [email protected]
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: What did you expect to happen?
+    validations:
+      required: true
+
+  - type: textarea
+    id: repro
+    attributes:
+      label: How can we reproduce it (as minimally and precisely as possible)?
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional
+    attributes:
+      label: Anything else we need to know?
+
+  - type: textarea
+    id: osVersion
+    attributes:
+      label: OS version
+      value: |
+        <details>
+
+        ```console
+        # On Linux:
+        $ cat /etc/os-release
+        # paste output here
+        $ uname -a
+        # paste output here
+
+        # On Windows:
+        C:\> wmic os get Caption, Version, BuildNumber, OSArchitecture
+        # paste output here
+        ```
+
+        </details>

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Support Request
+    url: https://discord.gg/hyperledger
+    about: Support request or question relating to Hyperledger Firefly

.github/ISSUE_TEMPLATE/enhancement.yml

@@ -0,0 +1,27 @@
+name: Enhancement Tracking Issue
+description: Provide supporting details for an enhancement
+labels: [enhancement]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        _The more information you share, the faster we can help you._
+        Prior to opening the issue, please make sure that you:
+        - Use English (EN/US) to communicate.
+        - Search the [open issues](https://github.com/hyperledger/firefly/issues) to avoid duplicating the issue.
+
+  - type: textarea
+    id: enhancement
+    attributes:
+      label: What would you like to be added?
+      description: |
+        A clear and concise description of what you want to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    id: rationale
+    attributes:
+      label: Why is this needed?
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/improve_docs.yml

@@ -0,0 +1,31 @@
+name: "Documentation Issue"
+description: Issues related to documentation.
+title: "docs: "
+labels: [documentation]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        _The more information you share, the faster we can help you._
+        Prior to opening the issue, please make sure that you:
+        - Use English (EN/US) to communicate.
+        - Search the [open issues](https://github.com/hyperledger/firefly/issues) to avoid duplicating the issue.
+
+  - type: textarea
+    id: current-state
+    attributes:
+      label: Current State
+      description: Describe the current state of the documentation.
+      placeholder: |
+        The documentation for the API in this page (url) is missing ...
+    validations:
+      required: true
+  - type: textarea
+    id: desired-state
+    attributes:
+      label: Desired State
+      description: Describe the desired state the documentation should be in.
+      placeholder: |
+        Add here ...
+    validations:
+      required: true

.github/pull_request_template.md

@@ -0,0 +1,46 @@
+<!--  Thanks for sending a pull request! -->
+
+## Proposed changes
+
+Please include a summary of the changes here and why we need those changes. And also let us know which issue is fixed. 
+
+Fixes # <issue_number_here>
+
+<hr>
+
+## Types of changes
+
+<!-- to mark a point done, place an x in square brackets. eg [x]-->
+<!-- - [x] done with this task-->
+<!----Please delete options that are not relevant. And in order to tick the check box just but x inside them for example [x] like this----->
+
+- [ ] Bug fix 
+- [ ] New feature added
+- [ ] Documentation Update 
+
+<hr>
+
+## Please make sure to follow these points 
+
+<!-- to mark a point done, place an x in square brackets. eg [x]-->
+<!-- - [x] done with this task-->
+<!----Please delete options that are not relevant. And in order to tick the check box just but x inside them for example [x] like this----->
+
+- [ ] I have read the contributing guidelines.
+- [ ] I have performed a self-review of my own code or work.
+- [ ] I have commented my code, particularly in hard-to-understand areas.
+- [ ] My changes generates no new warnings.
+- [ ] My Pull Request title is in format <code>< issue name ></code> eg <code>Added links in the documentation</code>.
+- [ ] I have added tests that prove my fix is effective or that my feature works.
+- [ ] My changes have sufficient code coverage (unit, integration, e2e tests).
+
+<hr>
+
+## Screenshots (If Applicable)
+
+<hr>
+
+
+## Other Information
+
+Any message for the reviewer or kick off the discussion by explaining why you considered this particular solution, any alternatives etc.

.github/workflows/docker_main.yml

@@ -4,10 +4,16 @@ on:
   push:
     branches:
       - main
+    paths-ignore:
+      - '.github/**' # exclude .github directory
+      - '**.md' # exclude all markdown files
 
 jobs:
   docker:
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
     steps:
       - uses: actions/checkout@v3
         with:

.github/workflows/docker_release.yml

@@ -5,13 +5,25 @@ on:
     types: [released, prereleased]
 
 jobs:
+   
   docker:
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
+      - name: Get the latest tag
+        id: get_latest_tag
+        run: |
+          git fetch --tags
+          latest_tag=$(git tag -l | sort -V | tail -n 1)
+          echo "latest tag: $latest_tag"
+          echo "LATEST_TAG=$latest_tag" >> $GITHUB_ENV
+      
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v2
 
@@ -25,9 +37,9 @@ jobs:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
-
+      
       - name: Set latest tag
-        if: github.event.action == 'released'
+        if: github.event.action == 'released' && github.ref_name == env.LATEST_TAG
         run: |
           echo "DOCKER_TAGS=${{ env.DOCKER_TAGS }},ghcr.io/${{ github.repository }}:latest" >> $GITHUB_ENV
 

.github/workflows/docs.yml

@@ -23,32 +23,24 @@ jobs:
           git config --global user.name "GitHub Actions"
           git config --global user.email "[email protected]"
 
-      - name: Check if this is the latest release
+      - name: Get the latest tag
         run: |
-          LATEST_TAG=$(
-            curl -L \
-              -H "Accept: application/vnd.github+json" \
-              -H "Authorization: Bearer ${{ github.token }}" \
-              -H "X-GitHub-Api-Version: 2022-11-28" \
-              https://api.github.com/repos/${{ github.repository }}/releases/latest \
-              | jq -r '.tag_name'
-          )
-          IS_LATEST=${{ env.LATEST_TAG == github.event.release.tag_name }}
-          echo This release is: "${{ github.event.release.tag_name }}"
-          echo The latest release is: "$LATEST_TAG"
-          echo "IS_LATEST_RELEASE=$IS_LATEST" >> "$GITHUB_ENV"
+          git fetch --tags
+          latest_tag=$(git tag -l | sort -V | grep -v "rc" | tail -n 1)
+          echo "latest tag: $latest_tag"
+          echo "LATEST_TAG=$latest_tag" >> $GITHUB_ENV
 
       - name: Install docs dependencies
         working-directory: doc-site
         run: pip install -r requirements.txt
 
       - name: Update doc site for release
-        if: ${{ github.event_name == 'release' && env.IS_LATEST_RELEASE != 'true' }}
+        if: github.event.action == 'released' && github.ref_name != env.LATEST_TAG
         working-directory: doc-site
         run: mike deploy ${{ github.event.release.tag_name }} --push
 
       - name: Update doc site for latest release
-        if: ${{ github.event_name == 'release' && env.IS_LATEST_RELEASE == 'true' }}
+        if: github.event.action == 'released' && github.ref_name == env.LATEST_TAG
         working-directory: doc-site
         run: mike deploy ${{ github.event.release.tag_name }} latest -u --push
 

.github/workflows/go.yml

@@ -3,8 +3,19 @@ name: Go
 on:
   push:
     branches: [main]
+    paths:
+      - '**'  # include all files
+      - '!.github/**' # exclude .github directory
+      - '!**.md' # exclude all markdown files
+      - 'doc-site/docs/reference/**.md' # include markdown files that are auto generated and need to be tested
+
   pull_request:
-    branches: [main]
+    paths:
+      - '**'  # include all files
+      - '!.github/**' # exclude .github directory
+      - '!**.md' # exclude all markdown files
+      - 'doc-site/docs/reference/**.md' # include markdown files that are auto generated and need to be tested
+
   workflow_dispatch:
 
 jobs:
@@ -20,13 +31,15 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v4
         with:
-          go-version: 1.21
+          go-version: 1.22
 
       - name: Build and Test
         run: make
 
-      - name: Upload coverage
-        run: bash <(curl -s https://codecov.io/bash)
+      - uses: codecov/codecov-action@v4
+        with:
+          codecov_yml_path: ./codecov.yml
+          token: ${{ secrets.CODECOV_TOKEN }}
 
   docker:
     runs-on: ubuntu-latest
@@ -38,7 +51,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v4
         with:
-          go-version: 1.21
+          go-version: 1.22
 
       - name: Build Docker image
         run: make docker
@@ -47,7 +60,7 @@ jobs:
         run: docker save --output firefly.tar.gz hyperledger/firefly
 
       - name: Upload Docker image
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: firefly-docker
           path: firefly.tar.gz
@@ -130,10 +143,10 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v4
         with:
-          go-version: 1.21
+          go-version: 1.22
 
       - name: Download Docker image
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: firefly-docker
 
@@ -152,7 +165,7 @@ jobs:
         run: ./test/e2e/run.sh
 
       - name: Archive container logs
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         if: always()
         with:
           name: container-logs-${{ matrix.test-suite }}-${{ matrix.blockchain-provider }}-${{ matrix.blockchain-connector }}-${{ matrix.database-type }}-${{ matrix.token-provider }}

.github/workflows/integration.yml

@@ -54,7 +54,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v4
         with:
-          go-version: 1.21
+          go-version: 1.22
 
       - name: Update manifest to latest commit for every service
         run: ./manifestgen.sh head
@@ -75,7 +75,7 @@ jobs:
         run: ./test/e2e/run.sh
 
       - name: Archive container logs
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         if: always()
         with:
           name: container-logs-${{ matrix.test-suite }}-${{ matrix.blockchain-node }}-${{ matrix.database-type }}
@@ -91,7 +91,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v4
         with:
-          go-version: 1.21
+          go-version: 1.22
 
       - name: Update manifest to latest commit for every service
         run: ./manifestgen.sh head
@@ -111,7 +111,7 @@ jobs:
         run: ./test/e2e/run.sh
 
       - name: Archive container logs
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         if: always()
         with:
           name: container-logs-TestEthereumV1MigrationE2ESuite-geth-postgres