Skip to content

chore: Add make help command #2180

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

Merged
merged 2 commits into from
May 16, 2025
Merged

chore: Add make help command #2180

merged 2 commits into from
May 16, 2025

Conversation

jkroepke
Copy link
Contributor

@jkroepke jkroepke commented May 8, 2025

Description

Minimalistic make help command to get the info with targets are availible without looking through the whole Makefile.

Project: stackit-sdk-go
Usage:
  make <target>

Targets:
  help                 show this help.
  lint                 Lint all code
  lint-golangci-lint   Lint Go code
  lint-scripts         Lint scripts
  project-help         Show help for the project
  project-tools        Install project tools
  sync-tidy            Sync and tidy dependencies
  test                 Run all tests
  test-go              Run Go tests
  test-scripts         Run tests for scripts

Checklist

  • Issue was linked above
  • No generated code was adjusted manually (check comments in file header)
  • Changelogs
    • Changelog in the root directory was adjusted (see here)
    • Changelog(s) of the service(s) were adjusted (see e.g. here)
  • Code format was applied: make fmt
  • Examples were added / adjusted (see examples/ directory)
  • Unit tests got implemented or updated
  • Unit tests are passing: make test (will be checked by CI)
  • No linter issues: make lint (will be checked by CI)

Copy link

This PR was marked as stale after 7 days of inactivity and will be closed after another 7 days of further inactivity. If this PR should be kept open, just add a comment, remove the stale label or push new commits to it.

@github-actions github-actions bot added the Stale label May 16, 2025
@jkroepke
Copy link
Contributor Author

@marceljk fyi

Copy link
Contributor

@marceljk marceljk left a comment

Choose a reason for hiding this comment

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

@jkroepke thanks for your contribution :) The PR looks good, only one nitpick in the comments. Afterwards the PR can be merged

@jkroepke jkroepke requested a review from marceljk May 16, 2025 08:36
jkroepke and others added 2 commits May 16, 2025 12:53
Signed-off-by: Jan-Otto Kröpke <[email protected]>
Co-authored-by: Marcel Jacek <[email protected]>
@marceljk marceljk merged commit 8cf26d6 into stackitcloud:main May 16, 2025
8 checks passed
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.

2 participants