CLI UX: 'axon run --dry-run' doesn't show auto-created Workspace and Secret resources
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 331
- Forks
- 40
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 70
Description
Problem
When running axon run --dry-run with a workspace configuration in ~/.axon/config.yaml, only the Task resource is displayed. The auto-created Workspace and Secret resources are not shown, which makes it unclear what will actually be created in the cluster.
Steps to Reproduce
- Create a config file with workspace settings:
apiKey: "fake-key"
workspace:
repo: https://github.com/test/test.git
ref: main
- Run:
axon run -p "test task" --dry-run
Current Behavior
Output only shows the Task resource:
apiVersion: axon.io/v1alpha1
kind: Task
metadata:
name: task-ksrtl
namespace: default
spec:
credentials:
secretRef:
name: axon-credentials # Created but not shown!
workspaceRef:
name: axon-workspace # Created but not shown!
...
Expected Behavior
The --dry-run flag should display ALL resources that would be created, including:
- The Secret resource (when using
apiKeyoroauthTokenin config) - The Workspace resource (when using inline workspace config)
- The Task resource
This would give users a complete picture of what will be created and help them understand the full impact of their command.
Why This Matters
- Users need to see secret names to understand what's being created
- Users need to verify workspace configuration before creating it
--dry-runshould show the complete truth of what will happen- This helps users learn the YAML structure and migrate to direct kubectl usage
Suggested Fix
Modify the --dry-run output to include all auto-created resources in a multi-document YAML format:
---
apiVersion: v1
kind: Secret
metadata:
name: axon-credentials
namespace: default
...
---
apiVersion: axon.io/v1alpha1
kind: Workspace
metadata:
name: axon-workspace
namespace: default
...
---
apiVersion: axon.io/v1alpha1
kind: Task
metadata:
name: task-ksrtl
namespace: default
...
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the axon run --dry-run entry point and reproduce the behavior with the workspace configuration in ~/.axon/config.yaml. Done means the output includes Secret, Workspace, and Task resources as separate YAML documents when those resources would be auto-created.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, kubernetes
- Domain
- cli
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100