Skip to content

Add diki run script in /hack#120

Merged
dimityrmirchev merged 8 commits intogardener:mainfrom
AleksandarSavchev:create-diki-script
Feb 20, 2024
Merged

Add diki run script in /hack#120
dimityrmirchev merged 8 commits intogardener:mainfrom
AleksandarSavchev:create-diki-script

Conversation

@AleksandarSavchev
Copy link
Copy Markdown
Member

What this PR does / why we need it:
This PR adds diki run script in /hack. The purpose of the script is to ease the use of diki. The main improvements are a comprehensive --help message and default ldflags flags.

Which issue(s) this PR fixes:
Fixes #118

Special notes for your reviewer:

Release note:

New `hack/run.sh` script that executes `diki run` added. The script sets default `ldflags` if not specified and provides a comprehensive `--help` message.

@gardener-robot gardener-robot added needs/review size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 2, 2024
@AleksandarSavchev AleksandarSavchev marked this pull request as ready for review February 6, 2024 09:35
@AleksandarSavchev AleksandarSavchev requested a review from a team as a code owner February 6, 2024 09:35
@AleksandarSavchev AleksandarSavchev deleted the create-diki-script branch February 6, 2024 10:25
@AleksandarSavchev AleksandarSavchev restored the create-diki-script branch February 6, 2024 10:25
@gardener-robot
Copy link
Copy Markdown
Contributor

@dimityrmirchev You have pull request review open invite, please check

Copy link
Copy Markdown
Member

@dimityrmirchev dimityrmirchev left a comment

Choose a reason for hiding this comment

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

Two small suggestions, other looks good

Comment thread docs/development/getting-started.md Outdated

## Running diki Locally

This document will walk you through running Diki against a local shoot cluster for development purposes. This guide uses the Gardener's local development setup.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
This document will walk you through running Diki against a local shoot cluster for development purposes. This guide uses the Gardener's local development setup.
This part will walk you through the process of running Diki against a local shoot cluster for development purposes. This guide uses the Gardener's local development setup.

Comment thread README.md Outdated

If you install via GitHub releases, you need to put the diki binary on your path.

You can also install diki using this code snippet:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
You can also install diki using this code snippet:
A sample install snippet for macOS can look like this:

Copy link
Copy Markdown
Member

@dimityrmirchev dimityrmirchev left a comment

Choose a reason for hiding this comment

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

/lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create a script that can run diki for development purposes

5 participants