uselagoon / uselagoon/lagoon-cli

"Dry run" mode

Open
#62 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

2023-rewrite
Dominant language
Go
Stars
28
Forks
14
Avg merge
1d 2h
Merged PRs (30d)
1

Description

Is your feature request related to a problem? Please describe.
I sometimes want to inspect the GraphQL query generated by the lagoon tool to ensure it's doing what I want, or providing all the fields that I would like, and that they are populated in the way I expect.

Describe the solution you'd like
It would be great to add a global flag -n/--dry-run, which just prints the GraphQL query JSON that would be sent to the server, to STDOUT instead.

Describe alternatives you've considered
Inspecting the source code.

Additional context
This feature request is modelled after the make -n flag.

There is some functionality overlap with the --debug flag, not sure the best way to resolve that. Although maybe --debug addresses a different use-case?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are named in the issue. Start by locating global flag registration, GraphQL query generation, and the existing --debug handling; compare their output paths and decide how dry-run behavior should relate to debug output. Done means -n/--dry-run prints the query JSON to STDOUT without sending it to the server.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.