Inconsistent Key Naming for IACM workspace.yaml file between docs/code

Open Beginner friendly
#95 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
go
Domain
documentation

Research direction

Compare the workspace.yaml naming shown in the linked IACM CLI documentation with the WorkspaceInfo struct and its yaml tags in the Go code. Confirm the canonical keys with the surrounding implementation, then update the documentation so its org, project, and workspace names match the supported configuration; done when the docs and code consistently describe the same keys.

Written by the indexing model from the issue text.

Description

The docs have a different naming scheme vs the code for the workspace.yaml file. the docs mention "org", "project", and "workspace", but the code uses "_id" on those names.

https://developer.harness.io/docs/infra-as-code-management/cli-commands/cli-iacm-plan/
Image

from the code:

// WorkspaceInfo holds org, project and workspace identifiers from CLI or .harness/workspace.yaml
type WorkspaceInfo struct {
	Org       string `yaml:"org_id"`
	Project   string `yaml:"project_id"`
	Workspace string `yaml:"workspace_id"`
}
Dominant language
Go
Stars
25
Forks
25
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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.

More from harness/harness-cli

All issues in harness/harness-cli

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.