Add version command

.github/workflows/main.yml

@@ -11,15 +11,15 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ ubuntu-latest, ubuntu-24.04-arm ]
+        os: [ubuntu-latest, ubuntu-24.04-arm]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4
 
       - name: Setup Go
         uses: actions/setup-go@v5
         with:
-          go-version: "1.22.2"
+          go-version-file: "go.mod"
 
       - name: Install dependencies
         run: sudo apt-get install libbtrfs-dev -y

.github/workflows/news.yaml

@@ -6,11 +6,11 @@ on:
       - main
 
 env:
-  python-version: '3.10'
+  python-version: "3.10"
   dependabot_user: "dependabot[bot]"
 
 permissions:
-    contents: read
+  contents: read
 
 jobs:
   # Check that a news file has been added to this branch when a PR is created

.github/workflows/release.yml

@@ -4,16 +4,14 @@ on:
   workflow_dispatch:
 
 env:
-  go-version: '1.22.2'
-  python-version: '3.10'
+  python-version: "3.10"
 
 jobs:
   # News file based version calculation
   create-release:
     runs-on: ubuntu-latest
     timeout-minutes: 60
     steps:
-
       - uses: tibdex/github-app-token@v2
         id: get_installation_token
         with:
@@ -29,7 +27,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v5
         with:
-          go-version: ${{ env.go-version }}
+          go-version-file: "go.mod"
 
       # Towncrier and CI tools are written in Python
       - uses: actions/setup-python@v5
@@ -62,7 +60,7 @@ jobs:
         uses: goreleaser/goreleaser-action@v6
         with:
           distribution: goreleaser
-          version: '~> v2'
+          version: "~> v2"
           args: release --clean
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.goreleaser.yaml

@@ -10,18 +10,25 @@ version: 2
 
 before:
   hooks:
-    - go mod tidy
+  - go mod tidy
 
 builds:
-  - env:
-      - CGO_ENABLED=0
-    goos:
-      - linux
-      - windows
-      - darwin
-    goarch:
-      - amd64
-      - arm64
+- id: kubearchinspect
+  env:
+  - CGO_ENABLED=0
+  goos:
+  - linux
+  - windows
+  - darwin
+  goarch:
+  - amd64
+  - arm64
+  main: .
+  ldflags:
+  - -s -w
+  - -X github.com/ArmDeveloperEcosystem/kubearchinspect/cmd.version={{.Version}}
+  - -X github.com/ArmDeveloperEcosystem/kubearchinspect/cmd.commit={{.Commit}}
+  - -X github.com/ArmDeveloperEcosystem/kubearchinspect/cmd.date={{.Date}}
 
 archives:
   - formats: tar.gz
@@ -42,8 +49,8 @@ changelog:
   sort: asc
   filters:
     exclude:
-      - "^docs:"
-      - "^test:"
+    - "^docs:"
+    - "^test:"
 release:
   draft: false
   replace_existing_draft: true

CODE_OF_CONDUCT.md

@@ -1,7 +1,8 @@
 <!--
-Copyright (C) 2024 Arm Limited or its affiliates and Contributors. All rights reserved.
+Copyright (C) 2025 Arm Limited or its affiliates and Contributors. All rights reserved.
 SPDX-License-Identifier: Apache-2.0
 -->
+
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge
@@ -14,21 +15,21 @@ We pledge to act and interact in ways that contribute to an open, welcoming, div
 
 Examples of behavior that contributes to a positive environment for our community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or
+- The use of sexualized language or imagery, and sexual attention or
   advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
   address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities
@@ -43,7 +44,7 @@ This Code of Conduct applies within all community spaces, and also applies when
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at support@arm.com. All complaints will be reviewed and investigated promptly and fairly.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at <support@arm.com>. All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the reporter of any incident.
 
@@ -71,18 +72,18 @@ Community leaders will follow these Community Impact Guidelines in determining t
 
 ### 4. Permanent Ban
 
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within the project community.
 
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+available at <https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
 
 Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
 
 [homepage]: https://www.contributor-covenant.org
 
 For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
+<https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.

CONTRIBUTING.md

@@ -1,7 +1,8 @@
 <!--
-Copyright (C) 2024 Arm Limited or its affiliates and Contributors. All rights reserved.
+Copyright (C) 2025 Arm Limited or its affiliates and Contributors. All rights reserved.
 SPDX-License-Identifier: Apache-2.0
 -->
+
 # Contribution Guide
 
 We really appreciate your contributions to this tool. We are committed to
@@ -17,7 +18,6 @@ There are several ways to contribute:
   - Add an enhancement feature.
   - Correct, update or add documentation.
 
-
 ## How to Contribute Documentation or Code
 
 Please keep contributions small and independent. We would much rather have multiple pull requests for each thing done
@@ -26,7 +26,7 @@ normal process to make a change is as follows:
 
 1. Fork the repository.
 2. Make your change and write unit tests, please try to match the existing documentation and coding style.
-3. Add a news file describing the changes and add it in the `/changes` directory, see the section [News Files](#news_files) below.
+3. Add a news file describing the changes and add it in the `/changes` directory, see the section [News Files](#news-files) below.
 4. Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
 5. Push to your fork.
 6. Submit a pull request.
@@ -46,15 +46,14 @@ tool.
   - The number is either the issue number or, if no issue exists, the date in the form `YYYYMMDDHHMM`.
   - The extension should indicate the type of change as described in the following table:
 
-| Change Type                                                                                                             | Extension  | Version Impact  |
-|-------------------------------------------------------------------------------------------------------------------------|------------|-----------------|
-| Backwards compatibility breakages or significant changes denoting a shift direction.                                    | `.major`   | Major increment |
-| New features and enhancements (non breaking).                                                                           | `.feature` | Minor increment |
-| Bug fixes or corrections (non breaking).                                                                                | `.bugfix`  | Patch increment |
-| Documentation impacting the consumer of the package (not repo documentation, such as this file, for this use `.misc`).  | `.doc`     | N/A             |
-| Deprecation of functionality or interfaces (not actual removal, for this use `.major`).                                 | `.removal` | None            |
-| Changes to the repository that do not impact functionality e.g. build scripts change.                                   | `.misc`    | None            |
-
+| Change Type                                                                                                            | Extension  | Version Impact  |
+| ---------------------------------------------------------------------------------------------------------------------- | ---------- | --------------- |
+| Backwards compatibility breakages or significant changes denoting a shift direction.                                   | `.major`   | Major increment |
+| New features and enhancements (non breaking).                                                                          | `.feature` | Minor increment |
+| Bug fixes or corrections (non breaking).                                                                               | `.bugfix`  | Patch increment |
+| Documentation impacting the consumer of the package (not repo documentation, such as this file, for this use `.misc`). | `.doc`     | N/A             |
+| Deprecation of functionality or interfaces (not actual removal, for this use `.major`).                                | `.removal` | None            |
+| Changes to the repository that do not impact functionality e.g. build scripts change.                                  | `.misc`    | None            |
 
 ## Merging the Pull Request
 
@@ -66,19 +65,19 @@ the changes:
 An emoji is used to highlight what has occurred in the change. Commonly used emojis can be seen below, but for a full
 list please see [Gitmoji](https://gitmoji.carloscuesta.me/):
 
-Emoji | Topic(s)
-------|---------
-✨ | New features or enhancements.
-🐛 | Bug / defect fixes.
-🔒 | Fixing security issues.
-⚡️ | Improving performance.
-♻️ | Refactoring or addressing technical debt.
-💥 | Breaking changes or removing functionality.
-❗️ | Notice of deprecation.
-📝 | Writing or updating documentation.
-👷 | Adding to the CI or build system.
-💚️ | Fixing CI or build system issues.
-🚀 | Releasing or deploying.
+| Emoji | Topic(s)                                    |
+| ----- | ------------------------------------------- |
+| ✨    | New features or enhancements.               |
+| 🐛    | Bug / defect fixes.                         |
+| 🔒    | Fixing security issues.                     |
+| ⚡️   | Improving performance.                      |
+| ♻️    | Refactoring or addressing technical debt.   |
+| 💥    | Breaking changes or removing functionality. |
+| ❗️    | Notice of deprecation.                      |
+| 📝    | Writing or updating documentation.          |
+| 👷    | Adding to the CI or build system.           |
+| 💚️   | Fixing CI or build system issues.           |
+| 🚀    | Releasing or deploying.                     |
 
 For more on the version number scheme please see the [ReadMe](./README.md).
 

DEVELOPMENT.md

@@ -1,8 +1,10 @@
 <!--
-Copyright (C) 2024 Arm Limited or its affiliates and Contributors. All rights reserved.
+Copyright (C) 2025 Arm Limited or its affiliates and Contributors. All rights reserved.
 SPDX-License-Identifier: Apache-2.0
 -->
+
 # Development and Testing
+
 ## Local Development
 
 ### Build manually
@@ -16,6 +18,7 @@ go build
 ### Running tests
 
 To run all tests:
+
 ```bash
 go test ./...
 ```
@@ -24,6 +27,7 @@ go test ./...
 
 Static analysis tools and linters are run as part of CI.
 They come from [golangci-lint](https://golangci-lint.run/). To run this locally:
+
 ```bash
 # Must be in a directory with a go.mod file
 cd <directory_with_go_module>
@@ -32,11 +36,11 @@ golangci-lint run ./...
 
 # Releasing
 
-### Release workflow
+## Release workflow
 
 1. Navigate to the [GitHub Actions](https://github.com/ArmDeveloperEcosystem/kubearchinspect/actions/workflows/release.yml) page.
 2. Select the **Run Workflow** button.
 
-### Version Numbers
+## Version Numbers
 
-The version number will be automatically calculated, based on the news files.
+The version number will be automatically calculated, based on the news files. This information will also be displayed when running the `version` command.

KNOWN_ISSUES.md

@@ -1,7 +1,8 @@
 <!--
-Copyright (C) 2024 Arm Limited or its affiliates and Contributors. All rights reserved.
+Copyright (C) 2025 Arm Limited or its affiliates and Contributors. All rights reserved.
 SPDX-License-Identifier: Apache-2.0
 -->
+
 # Known Issues
 
 This project is a work-in-progress and we are not currently tracking issues.

LICENSE.txt

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2024 Arm Limited
+   Copyright 2025 Arm Limited
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -1,5 +1,5 @@
 <!--
-Copyright (C) 2024 Arm Limited or its affiliates and Contributors. All rights reserved.
+Copyright (C) 2025 Arm Limited or its affiliates and Contributors. All rights reserved.
 SPDX-License-Identifier: Apache-2.0
 -->
 
@@ -32,15 +32,29 @@ Pre-built binaries are available from the [releases page](https://github.com/Arm
 ### Usage
 
 ```console
-kubearchinspect [OPTIONS]
+kubearchinspect [command] [flags]
 ```
 
-### Options
+### Commands
 
 - `images` : Check which images in your cluster support arm64
+
+  | Flag                              | Description                                                                 |
+  | --------------------------------- | --------------------------------------------------------------------------- |
+  | `-c`, `--kube-config-path string` | Path to your Kube config file. (Default: `~/.kube/config`)                  |
+  | `--kube-context string`           | The Kubernetes context to be used. (Default: Current context in the config) |
+
+- `version` : Check the version of KubeArchInspect you are running
 - `completion` : Generate the autocompletion script for the specified shell
 - `help` : Help about any command
 
+### Global Flags
+
+| Flag                 | Description       |
+| -------------------- | ----------------- |
+| `-d`, `--debug`      | Enable debug mode |
+| `-l`, `--log string` | Enable logging    |
+
 ## Example
 
 Output from a small cluster in EKS:

SECURITY.md

@@ -1,7 +1,8 @@
 <!--
-Copyright (C) 2024 Arm Limited or its affiliates and Contributors. All rights reserved.
+Copyright (C) 2025 Arm Limited or its affiliates and Contributors. All rights reserved.
 SPDX-License-Identifier: Apache-2.0
 -->
+
 # Security Policy
 
 ## Reporting a Vulnerability

changes/29.feature

@@ -0,0 +1 @@
+Add `version` command

changes/README.md

@@ -1,7 +1,8 @@
 <!--
-Copyright (C) 2024 Arm Limited or its affiliates and Contributors. All rights reserved.
+Copyright (C) 2025 Arm Limited or its affiliates and Contributors. All rights reserved.
 SPDX-License-Identifier: Apache-2.0
 -->
+
 # Changes directory
 
 This directory comprises information about all the changes that happened since the last release.