Skip to content

Update setup instructions - #437

Merged
adamtrizuljak-sap merged 1 commit into
mainfrom
chore/readme-setup-instructions
Jul 30, 2026
Merged

Update setup instructions#437
adamtrizuljak-sap merged 1 commit into
mainfrom
chore/readme-setup-instructions

Conversation

@adamtrizuljak-sap

@adamtrizuljak-sap adamtrizuljak-sap commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

I am updating the setup instructions based on my recent experience with installing the dev environment on MacOS.

  • Add prerequisites into README. I'm just listing the packages and not including exact shell commands, as these will differ per OS and package manager
  • Add a new prepare setup target that wraps all make targets that install dependencies. Suggestions for a better name are welcome :)

@adamtrizuljak-sap
adamtrizuljak-sap requested review from a team and nikatza July 9, 2026 14:11
@github-actions github-actions Bot added the size/S label Jul 9, 2026
@adamtrizuljak-sap
adamtrizuljak-sap force-pushed the chore/readme-setup-instructions branch from c9377d6 to 6972a4d Compare July 9, 2026 14:11

@felix-kaestner felix-kaestner left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

As for naming suggestions, I could think of "setup" as you already named the branch and PR that way. So I think that would be quite intuitive. But also no strong opinion here.

@adamtrizuljak-sap
adamtrizuljak-sap force-pushed the chore/readme-setup-instructions branch from 6972a4d to eb1d94c Compare July 9, 2026 14:23

@nikatza nikatza left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nice! Thx!

@rgildein

Copy link
Copy Markdown

IMO I will remove all "install-*" command and define list of required tool in README. It should be up to user how to install those tools (brew, macports, nix, apt, snap, source, ...) and on what machine (this does not work on fresh VM with ubuntu).

@felix-kaestner

felix-kaestner commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

IMO I will remove all "install-*" command and define list of required tool in README. It should be up to user how to install those tools (brew, macports, nix, apt, snap, source, ...) and on what machine (this does not work on fresh VM with ubuntu).

On that note, #397 might be a welcome change because it follows the kubebuilder convention of installing required tooling local within the project only (not system-wide) into a /bin directory, completely removing the need for these install-* commands.

At the same time, this eliminates the problems of different people having different versions of the same tool installed on their machine, leading to differences in e.g. code generation or formatting, as the versions used by this repo would be pinned.

@adamtrizuljak-sap
adamtrizuljak-sap force-pushed the chore/readme-setup-instructions branch 2 times, most recently from 1ec6f06 to 2fab064 Compare July 24, 2026 10:00
@adamtrizuljak-sap
adamtrizuljak-sap force-pushed the chore/readme-setup-instructions branch from 2fab064 to 4832b84 Compare July 30, 2026 13:47
@github-actions github-actions Bot added size/M and removed size/S labels Jul 30, 2026
@adamtrizuljak-sap
adamtrizuljak-sap force-pushed the chore/readme-setup-instructions branch from 4832b84 to 5ab746e Compare July 30, 2026 13:52
Add prerequisites into README. I'm just listing the packages and not including exact shell commands, as these will differ per OS and package manager

Signed-off-by: Adam Trizuljak <adam.trizuljak@sap.com>
@github-actions github-actions Bot added size/XS and removed size/M labels Jul 30, 2026
@adamtrizuljak-sap
adamtrizuljak-sap force-pushed the chore/readme-setup-instructions branch from 5ab746e to 97aaeae Compare July 30, 2026 13:53
@adamtrizuljak-sap
adamtrizuljak-sap enabled auto-merge (squash) July 30, 2026 13:54
@adamtrizuljak-sap
adamtrizuljak-sap merged commit 596fdb4 into main Jul 30, 2026
9 checks passed
@adamtrizuljak-sap
adamtrizuljak-sap deleted the chore/readme-setup-instructions branch July 30, 2026 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants