workplan

Workplan

The workplan cmd is meant to generate a workplan template for use in investigating a feature/problem and rendering an idea of how much work is needed to complete it. Currently, the workplan is set to publish to JIRA and the publishing feature will not work with any other work product tool at this time.

Setup

Add the following to your mise.toml file

[tools]
"go:github.com/project-init/devex/cmd/workplan" = "latest"

Then you can run the cmd like

workplan generate <directory> <title>

For example:

workplan generate docs/investigations/infrastructure/moveToProjectInitStack example_title

This will generate a workplan template in the specified directory with the specified title. It'll be structured like this:

<directory>
└── <yyyy>_<m>_<d>_example_title
    └── workplan.yaml
    └── problem.md

Then once you fill in and review that content you can run

# Your Jira url will look something like `https://yourdomain.atlassian.net`
export JIRA_URL=<your_url>
export JIRA_EMAIL=<your_jira_email>
export JIRA_API_KEY=<your_api_key>

# Run this command next
workplan publish docs/investigations/infrastructure/moveToProjectInitStack/workplan.yaml

See section below for how to get your JIRA API key. You will likely want to set the JIRA env variables in a zshrc setup of some kind so you don't have to repeat the first 3 steps.

Getting your JIRA API key

1. Navigate to https://id.atlassian.com/manage-profile/security/api-tokens
2. Click "Create API token"
3. Give it a name and click "Create"
4. Copy the token and ensure it is available for use in your environment variables as mentioned in the setup section above.

Why Jira?

Most common tool that the project-init team has used, so that is what we set up to work with. We aren't declaring that JIRA is the best tool, just that it is what we have the knowledge on how to work with so we set up publishing towards it.