Merge branch 'main' into test/collector

.github/workflows/codeql.yml

@@ -0,0 +1,71 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  schedule:
+    - cron: "30 15 * * 0" # run every Sunday at 15:30 UTC
+
+jobs:
+  analyze:
+    permissions:
+      security-events: write
+      actions: read
+      contents: read
+    name: Analyze
+    runs-on: ubuntu-22.04
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ["go"]
+        # CodeQL supports [ 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift' ]
+        # Use only 'java-kotlin' to analyze code written in Java, Kotlin or both
+        # Use only 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@8a470fddafa5cbb6266ee11b37ef4d8aae19c571 # v3.24.6
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+
+          # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+          # queries: security-extended,security-and-quality
+
+      - name: Setup Golang Environment
+        uses: actions/setup-go@0c52d547c9bc32b1aa3301fd7a9cb496313a4491 # v5.0.0
+        with:
+          go-version: stable
+        if: matrix.language == 'go'
+
+      # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@8a470fddafa5cbb6266ee11b37ef4d8aae19c571 # v3.24.6
+
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+      #   If the Autobuild fails above, remove it and uncomment the following three lines.
+      #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+      # - run: |
+      #     echo "Run, Build Application using script"
+      #     ./location_of_script_within_repo/buildscript.sh
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@8a470fddafa5cbb6266ee11b37ef4d8aae19c571 # v3.24.6
+        with:
+          category: "/language:${{matrix.language}}"

README.md

@@ -1 +1,26 @@
-# telemetry-exporter
+# Telemetry Exporter
+
+This project is a library that exports product telemetry data to an F5-managed service.
+
+It is used by [NGINX Ingress Controller](https://github.com/nginxinc/kubernetes-ingress)
+and [NGINX Gateway Fabric](https://github.com/nginxinc/nginx-gateway-fabric) projects.
+
+## Contacts
+
+If you experience issues with this project, please [open a bug][bug] in
+GitHub. If you have any suggestions or feature requests, please [open an idea][idea] on GitHub discussions.
+
+You can  contact us directly via kubernetes@nginx.com or on the [NGINX Community Slack][slack] in
+the `#kubernetes` channel.
+
+[bug]: https://github.com/nginxinc/telemetry-exporter/issues/new?assignees=&labels=&projects=&template=bug_report.md&title=
+[idea]: https://github.com/nginxinc/telemetry-exporter/discussions/categories/ideas
+[slack]: https://nginxcommunity.slack.com/channels/kubernetes
+
+## Contributing
+
+Please read our [Contributing guide](CONTRIBUTING.md) if you'd like to contribute to the project.
+
+## Support
+
+This project is not covered by any support contract.