Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add the --format option to the finch version command #926

Merged
merged 1 commit into from
May 8, 2024

Conversation

haytok
Copy link
Member

@haytok haytok commented May 2, 2024

Currently, the finch version command does not support the --format option.

However, a feature request has been submitted in the following issue to add the --format option to the finch version command.

Therefore, this fix introduces the --format option to the finch version command.

Issue #, if available:

Description of changes: Details are described in this commit message.

Testing done: Yes

  • I've reviewed the guidance in CONTRIBUTING.md

License Acceptance

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@haytok haytok requested review from pendo324 and Shubhranshu153 May 2, 2024 07:51
@haytok
Copy link
Member Author

haytok commented May 2, 2024

The e2e tests related to the finch version command that I modified are currently failing, so I'll fix them.

Summarizing 1 Failure:
  [FAIL]  Check finch version [It] Should print finch version information
  /Users/ec2-user/ar/_work/finch/finch/e2e/vm/version_test.go:73

I'll particularly re-examine the following areas.

@haytok
Copy link
Member Author

haytok commented May 2, 2024

The e2e tests for the finch version command were failing due to the following refactored part when outputting finch version.

According to the template syntax, this commit required changing the output order of GitCommit and OS/Arch.

The e2e tests also needed to be update, so I'll update the e2e tests.

Copy link
Member

@pendo324 pendo324 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, can you also run the finch gen-docs generate command and commit the results? This will get the new --format flag added to https://github.com/runfinch/finch/blob/main/docs/cmd/finch_version.md (and eventually the runfinch/finch website)

@pendo324
Copy link
Member

pendo324 commented May 7, 2024

Also, this should probably be a feat: tag instead of a fix:, since its a new feature

Currently, the `finch version` command does not support the `--format`
option.

However, a feature request has been submitted in the following issue to
add the `--format` option to the `finch version` command.

  - runfinch#199

Therefore, this fix introduces the `--format` option to the
`finch version` command.

Signed-off-by: Hayato Kiwata <[email protected]>
@haytok haytok force-pushed the add-format-option branch from db016a4 to 3456abe Compare May 8, 2024 09:31
@haytok haytok changed the title fix: Add the --format option to the finch version command. feat: Add the --format option to the finch version command. May 8, 2024
@haytok haytok changed the title feat: Add the --format option to the finch version command. feat: Add the --format option to the finch version command May 8, 2024
@haytok
Copy link
Member Author

haytok commented May 8, 2024

Hi, @pendo324

Thanks for review!!!
I have added the docs and amended the commit message title.
Could you please review it again?

@haytok
Copy link
Member Author

haytok commented May 8, 2024

Thanks for approving this PR.
I'll merge this :)

@haytok haytok merged commit a9d04e3 into runfinch:main May 8, 2024
37 checks passed
henry118 pushed a commit that referenced this pull request Jun 3, 2024
🤖 I have created a release *beep* *boop*
---


## [1.2.0](v1.1.3...v1.2.0)
(2024-06-03)


### Build System or External Dependencies

* **deps:** Bump github.com/aws/aws-sdk-go-v2 from 1.26.0 to 1.26.1
([#882](#882))
([c059d9e](c059d9e))
* **deps:** Bump github.com/aws/aws-sdk-go-v2 from 1.26.1 to 1.27.0
([#954](#954))
([b06280c](b06280c))
* **deps:** Bump github.com/docker/cli from 26.0.0+incompatible to
26.0.1+incompatible
([#894](#894))
([680e23f](680e23f))
* **deps:** Bump github.com/docker/cli from 26.0.1+incompatible to
26.0.2+incompatible
([#906](#906))
([6fc6ce5](6fc6ce5))
* **deps:** Bump github.com/docker/cli from 26.0.2+incompatible to
26.1.0+incompatible
([#913](#913))
([bfeb585](bfeb585))
* **deps:** Bump github.com/docker/cli from 26.1.0+incompatible to
26.1.1+incompatible
([#922](#922))
([7b6b3d2](7b6b3d2))
* **deps:** Bump github.com/docker/cli from 26.1.1+incompatible to
26.1.2+incompatible
([#941](#941))
([eec3462](eec3462))
* **deps:** Bump github.com/docker/cli from 26.1.2+incompatible to
26.1.3+incompatible
([#952](#952))
([9a94c57](9a94c57))
* **deps:** Bump github.com/docker/docker from 26.0.0+incompatible to
26.0.1+incompatible
([#892](#892))
([05610c1](05610c1))
* **deps:** Bump github.com/docker/docker from 26.0.1+incompatible to
26.0.2+incompatible
([#905](#905))
([69e7d0b](69e7d0b))
* **deps:** Bump github.com/docker/docker from 26.0.2+incompatible to
26.1.0+incompatible
([#912](#912))
([5e5f8a8](5e5f8a8))
* **deps:** Bump github.com/docker/docker from 26.1.0+incompatible to
26.1.1+incompatible
([#924](#924))
([79eb863](79eb863))
* **deps:** Bump github.com/docker/docker from 26.1.1+incompatible to
26.1.2+incompatible
([#940](#940))
([aa3ab01](aa3ab01))
* **deps:** Bump github.com/docker/docker from 26.1.2+incompatible to
26.1.3+incompatible
([#951](#951))
([cef9d8f](cef9d8f))
* **deps:** Bump github.com/lima-vm/lima from 0.21.0 to 0.22.0
([#934](#934))
([62d67d5](62d67d5))
* **deps:** Bump github.com/onsi/ginkgo/v2 from 2.17.1 to 2.17.2
([#920](#920))
([939639e](939639e))
* **deps:** Bump github.com/onsi/ginkgo/v2 from 2.17.2 to 2.17.3
([#933](#933))
([c56019d](c56019d))
* **deps:** Bump github.com/onsi/ginkgo/v2 from 2.17.3 to 2.19.0
([#959](#959))
([08d7a34](08d7a34))
* **deps:** Bump github.com/onsi/gomega from 1.33.0 to 1.33.1
([#923](#923))
([e7f4e0d](e7f4e0d))
* **deps:** Bump github.com/runfinch/common-tests from 0.7.18 to 0.7.21
([#878](#878))
([e1cbd0a](e1cbd0a))
* **deps:** Bump github.com/runfinch/common-tests from 0.7.21 to 0.7.22
([#907](#907))
([84b4a69](84b4a69))
* **deps:** Bump github.com/shirou/gopsutil/v3 from 3.24.2 to 3.24.3
([#881](#881))
([465e369](465e369))
* **deps:** Bump github.com/shirou/gopsutil/v3 from 3.24.3 to 3.24.4
([#925](#925))
([8cd5643](8cd5643))
* **deps:** Bump github.com/shirou/gopsutil/v3 from 3.24.4 to 3.24.5
([#962](#962))
([8e51db3](8e51db3))
* **deps:** Bump github.com/tc-hib/go-winres from 0.3.1 to 0.3.3
([#893](#893))
([ebb4c9f](ebb4c9f))
* **deps:** Bump golang.org/x/crypto from 0.22.0 to 0.23.0
([#928](#928))
([1687293](1687293))
* **deps:** Bump golang.org/x/text from 0.14.0 to 0.15.0
([#929](#929))
([85e1bec](85e1bec))
* **deps:** Bump golang.org/x/tools from 0.19.0 to 0.20.0
([#889](#889))
([cfac010](cfac010))
* **deps:** Bump golang.org/x/tools from 0.20.0 to 0.21.0
([#932](#932))
([a853a8a](a853a8a))
* **deps:** Bump k8s.io/apimachinery from 0.29.3 to 0.30.0
([#904](#904))
([f8b7f25](f8b7f25))
* **deps:** Bump k8s.io/apimachinery from 0.30.0 to 0.30.1
([#946](#946))
([dc4ebf9](dc4ebf9))
* **deps:** Bump submodules and dependencies
([#874](#874))
([a9f73be](a9f73be))
* **deps:** Bump submodules and dependencies
([#895](#895))
([c7388bb](c7388bb))
* unify macos/windows yamls
([#921](#921))
([86d9a23](86d9a23))


### Features

* Add the --format option to the finch version command
([#926](#926))
([a9d04e3](a9d04e3))
* make Virtualization Framework default
([#956](#956))
([75b69b8](75b69b8))


### Bug Fixes

* add finch vm settings subcommand
([#887](#887))
([8e809cc](8e809cc))
* Remove unnecessary error handling
([#961](#961))
([f441fc9](f441fc9))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants