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

✨ New CLI UX #37

Merged
merged 48 commits into from
Feb 9, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
b6be58f
changed the ksctl/v1 -> /v2
dipankardas011 Jan 27, 2025
4684684
added config based ksctl cli and some more advanced features
dipankardas011 Jan 27, 2025
27b1045
updated the comment
dipankardas011 Jan 28, 2025
f8f48d9
added a few changes
dipankardas011 Jan 28, 2025
b743c1c
commands implementation
dipankardas011 Jan 28, 2025
8d56227
fixed the logger verbosity
dipankardas011 Jan 28, 2025
29a443c
some changes
dipankardas011 Jan 28, 2025
e6cc818
added version, scaleup/down, configure
dipankardas011 Jan 28, 2025
450b6e0
improvements in the menu driven approach
dipankardas011 Jan 29, 2025
00dada7
added metadata from userinput
dipankardas011 Jan 29, 2025
fbc7998
improved the logging from pterm pkg
dipankardas011 Jan 29, 2025
b913f5d
feat(configure): added the complete implementation
dipankardas011 Jan 30, 2025
66e7333
improved the configure and create
dipankardas011 Jan 31, 2025
c40d06e
updated the dependency
dipankardas011 Jan 31, 2025
b5ecfd2
updated the docs for cli
dipankardas011 Feb 1, 2025
01ab6ec
patch ci for docs sync
dipankardas011 Feb 1, 2025
ca56b04
sync docs workflow fix
dipankardas011 Feb 1, 2025
f780914
Merge branch 'main' into new-cli
dipankardas011 Feb 1, 2025
c9a0c25
started to make the development mode start
dipankardas011 Feb 1, 2025
76e8f63
feat(az-meta): region as dropdown from sync metadata ksctl core
dipankardas011 Feb 2, 2025
e04b175
patched the cli
dipankardas011 Feb 2, 2025
c2b36a8
added vm listing selection
dipankardas011 Feb 2, 2025
336fc65
added the instance_type in selection
dipankardas011 Feb 3, 2025
dc81a5f
updated the spinner for the logging
dipankardas011 Feb 3, 2025
9f7a77a
added user input on managed cluster aks
dipankardas011 Feb 3, 2025
b39276f
new color profile for cli logger
dipankardas011 Feb 4, 2025
f946df7
added aws instance
dipankardas011 Feb 4, 2025
1d77d48
added the kubernetes version
dipankardas011 Feb 5, 2025
ec1763d
added managed cluster support
dipankardas011 Feb 5, 2025
7196aa3
added infra inputs for selfmanaged
dipankardas011 Feb 6, 2025
d2e8065
added the bootstrap version fields
dipankardas011 Feb 6, 2025
2f1b77e
added a new spinner
dipankardas011 Feb 6, 2025
3403bd8
added field etcdVersion to the ksctl Client Metadata
dipankardas011 Feb 6, 2025
e6ee0bb
changes to the log table method
dipankardas011 Feb 6, 2025
1e6b422
added cost for self-managed cluster in table format
dipankardas011 Feb 6, 2025
bfbf374
changed the color scheme for table output
dipankardas011 Feb 8, 2025
3dd998c
added create, list and delete cluster
dipankardas011 Feb 8, 2025
f843f34
patched the delete and create summary
dipankardas011 Feb 9, 2025
2910d46
added get, list, connect commands
dipankardas011 Feb 9, 2025
5364c6b
improved the verbosity flag
dipankardas011 Feb 9, 2025
a714ce1
fixed the get cluster haproxy version
dipankardas011 Feb 9, 2025
ccbb02e
added scale up/down and version
dipankardas011 Feb 9, 2025
c166a88
new ansi art for ksctl cli
dipankardas011 Feb 9, 2025
3ed40b4
updated the go releaser and version
dipankardas011 Feb 9, 2025
384879d
fixed the ci workflows
dipankardas011 Feb 9, 2025
9f6e52a
bumped to [email protected]
dipankardas011 Feb 9, 2025
af00b63
updated the script for checking build process
dipankardas011 Feb 9, 2025
fca49a9
fixed the ci
dipankardas011 Feb 9, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 61 additions & 41 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -1,95 +1,115 @@
name: Bug Report
description: Report a bug to help us improve
title: "[Bug Report]: "
description: "πŸ› Report a bug to help us improve"
title: "[Bug]: "
labels: ["kind/bug", "needs-triage", "priority/high"]

body:
- type: markdown
attributes:
value: |
**Thank you for reporting a bug.** Your feedback is valuable to us. Please fill in as much of the template below as you're able, to help us better understand and fix the bug.
# πŸ” Bug Report

Thank you for taking the time to report a bug! Your feedback helps make our project better.

> πŸ’‘ Before submitting, please search existing issues to avoid duplicates.

Please fill out the information below as detailed as possible.

- type: input
id: bug-title
attributes:
label: Bug Title
description: Provide a concise title that summarizes the bug.
placeholder: Short and descriptive title of the bug
label: "πŸ“ Bug Title"
description: "Give your bug a clear and descriptive title"
placeholder: "Example: CLI crashes when creating cluster with custom configuration"
validations:
required: true

- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to Reproduce
description: Describe the steps to reproduce the bug. Be as detailed as possible.
placeholder: 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error
label: "πŸ”„ Steps to Reproduce"
description: "Help us recreate the issue by providing detailed steps"
placeholder: |
1. Install ksctl version X.Y.Z
2. Run command `...`
3. Configure settings with...
4. Observe error...
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: Describe what you expected to happen.
placeholder: Describe the expected outcome after following the steps above.
label: "βœ… Expected Behavior"
description: "What should have happened?"
placeholder: "Describe what you expected to happen when following the steps above"
validations:
required: true

- type: textarea
id: actual-behavior
attributes:
label: Actual Behavior
description: Describe what actually happened instead.
placeholder: Describe the actual outcome after following the steps above.
label: "❌ Actual Behavior"
description: "What happened instead?"
placeholder: |
Describe what actually happened. If you have error messages or screenshots, please include them here.

```
Include any error messages or logs here
```
validations:
required: true

- type: input
id: environment
attributes:
label: Environment
description: Include details like the ksctl version, operating system, and the version of the software in which the bug occurred.
placeholder: e.g., ksctl cli on Windows 10, version 1.3
label: "πŸ–₯️ Environment"
description: |
Tell us about your environment (OS, software versions, etc.)
placeholder: "ksctl v1.3.0, Ubuntu 22.04, Docker 24.0.5"
validations:
required: true

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Provide any additional context about the problem here. Screenshots or error logs are very helpful.
placeholder: Any additional information, screenshots, or logs that might help us understand the problem better.
label: "πŸ“Ž Additional Context"
description: |
Add any other context, screenshots, or logs about the problem here.
Tip: You can attach images by dragging & dropping them into this field.
placeholder: "Share any additional information that might help us understand the issue better"
validations:
required: false

- type: checkboxes
id: confirmation
id: affected-components
attributes:
label: Confirmation
description: "Please confirm the following:"
label: "🎯 Affected Components"
description: "Which parts of the project are affected by this bug?"
options:
- label: I have searched the existing issues and this is a new and unique bug report.
required: true
- label: I agree to provide follow-up information if needed.
required: true
- label: "πŸ–₯️ CLI"
- label: "🎨 UI"
- label: "πŸ“š Documentation"
- label: "πŸ”§ Core Functionality"
- label: "πŸ”Œ Plugins/Extensions"

- type: checkboxes
id: updates
id: confirmations
attributes:
label: Scope of changes
description: what all subprojects will be affected?
label: "βœ”οΈ Confirmations"
description: "Please confirm the following:"
options:
- label: Cli
- label: UI
- label: Docs
- label: "πŸ” I have searched existing issues and verified this is a new bug"
required: true
- label: "πŸ’¬ I will respond to questions and updates in this bug report"
required: true
- label: "πŸ“œ I have read and agree to follow the [Contribution Guidelines](https://docs.ksctl.com/docs/contribution-guidelines/)"
required: true

- type: checkboxes
id: agreement
- type: markdown
attributes:
label: Agreement
description: By submitting this feature proposal, you agree to engage in constructive discussion and follow our [Contribution Guidelines](https://docs.ksctl.com/docs/contribution-guidelines/)
options:
- label: I agree to engage in constructive discussion and follow the Contribution Guidelines.
required: true
value: |
---
πŸ‘₯ Our maintainers will review your bug report and get back to you as soon as possible.

⭐ Thank you for contributing to make our project better!
106 changes: 79 additions & 27 deletions .github/ISSUE_TEMPLATE/enhancement-proposal.yml
Original file line number Diff line number Diff line change
@@ -1,76 +1,128 @@
name: Enhancement Proposal
description: Suggest an enhancement for an existing feature or propose a new functionality
title: "[Enhancement Proposal]: "
description: "✨ Propose new features or improvements to existing functionality"
title: "[Enhancement]: "
labels: ["kind/enhancement", "needs-triage"]

body:
- type: markdown
attributes:
value: |
**Thank you for suggesting an enhancement.** Please fill in as much of the template below as you're able. Your proposal will help us understand your ideas better and improve the project.
# ✨ Enhancement Proposal

Thank you for helping improve our project! Your ideas and suggestions are valuable to us.

> πŸ’‘ Before submitting, please check if a similar enhancement has been proposed.

Let's hear about your amazing idea! πŸš€

- type: input
id: enhancement-title
attributes:
label: Enhancement Title
description: Provide a concise title for your enhancement proposal.
placeholder: Short and descriptive title
label: "πŸ“Œ Enhancement Title"
description: "Give your enhancement a clear and descriptive title"
placeholder: "Example: Add support for custom backup schedules"
validations:
required: true

- type: textarea
id: enhancement-summary
attributes:
label: Summary of the Enhancement
description: A brief summary of the enhancement you're proposing.
placeholder: What enhancement are you proposing and why?
label: "πŸ’« Enhancement Summary"
description: "Provide a brief overview of your proposed enhancement"
placeholder: |
Briefly describe:
- What is the enhancement?
- Who will benefit from it?
- How does it improve the project?
validations:
required: true

- type: textarea
id: motivation-and-goals
attributes:
label: Motivation and Goals
description: What motivates you to propose this enhancement? What goals do you aim to achieve?
placeholder: Explain the motivation behind this proposal and what you hope to achieve.
label: "🎯 Motivation and Goals"
description: "Help us understand the 'why' behind your proposal"
placeholder: |
- What problem does this solve?
- What use cases does it address?
- What benefits will it bring to users?
validations:
required: true

- type: textarea
id: detailed-design
attributes:
label: Detailed Design
description: Describe in detail how this enhancement should be implemented. Include any specific technical requirements, methods, or steps.
placeholder: Detailed description of the enhancement's design and implementation.
label: "πŸ”¨ Detailed Design"
description: "Describe how your enhancement should work"
placeholder: |
Please include:
- Technical implementation details
- Required changes to existing features
- Any new interfaces or APIs
- Performance considerations

You can use diagrams or code examples:
```yaml
example:
configuration:
- setting: value
```
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives
description: Have you considered any alternative solutions or features? Why is your proposed enhancement preferable?
placeholder: Describe any alternative solutions or features you've considered.
label: "πŸ€” Alternative Approaches"
description: "What other approaches have you considered?"
placeholder: |
- Alternative solution 1 and why it was not chosen
- Alternative solution 2 and its trade-offs
- Current workarounds, if any
validations:
required: false

- type: checkboxes
id: updates
id: impact-areas
attributes:
label: Scope of changes
description: what all subprojects will be affected?
label: "🎯 Impact Areas"
description: "Which parts of the project will be affected?"
options:
- label: Cli
- label: UI
- label: Docs
- label: "πŸ–₯️ CLI - Command line interface changes"
- label: "🎨 UI - User interface modifications"
- label: "πŸ“š Documentation - Documentation updates"
- label: "βš™οΈ Core - Core functionality changes"
- label: "πŸ”Œ API - API modifications"
- label: "πŸ§ͺ Tests - Test suite updates"

- type: textarea
id: additional-context
attributes:
label: "πŸ“Ž Additional Context"
description: "Any other context or screenshots about the enhancement"
placeholder: "Add any other relevant information, mockups, or examples here"
validations:
required: false

- type: checkboxes
id: agreement
attributes:
label: Agreement
description: By submitting this feature proposal, you agree to engage in constructive discussion and follow our [Contribution Guidelines](https://docs.ksctl.com/docs/contribution-guidelines/)
label: "πŸ“ Agreement"
description: |
By submitting this enhancement proposal, you agree to:
options:
- label: I agree to engage in constructive discussion and follow the Contribution Guidelines.
- label: "🀝 Engage in constructive discussion and follow our [Contribution Guidelines](https://docs.ksctl.com/docs/contribution-guidelines/)"
required: true
- label: "πŸ’ͺ Help implement this enhancement if approved (optional)"
- label: "πŸ“’ Provide additional information if requested"
required: true

- type: markdown
attributes:
value: |
---
### πŸ™ Thank you for your contribution!

Your enhancement proposal will be reviewed by our maintainers. We'll discuss the implementation details and feasibility together.

> ⭐ Don't forget to star the repository if you haven't already!
Loading
Loading