Workauto
Workauto is a VS Code assistant that streamlines Jira-driven development flows.
It opens an in-editor dashboard where you can fetch Jira metadata, automate Git
tasks (commit, checkout, merge, push), visualize progress, and trigger Jenkins
builds without leaving the editor.
Features
- Command palette entry – Run
Workauto: 打开主界面 to launch the React
webview that powers the assistant.
- Jira integration – Enter a Jira issue number to pull its summary/status
via the REST API and auto-generate a conventional commit message.
- Git-aware “一键构建” – Detect the current/local branches, run the required
git commit, checkout, pull, merge, and push steps, and mirror their
statuses in the Build Status timeline.
- Jenkins automation – Derive the job URL from the current repo name,
compare the last successful build branch, show a confirmation modal when it
differs, and finally call
/buildWithParameters with the selected branch.
- Config-first UX – A dedicated tab lets you store Jira credentials,
project prefix, and Jenkins user/token; the data is persisted to disk so the
assistant can reuse it on every launch.
Requirements
- VS Code
1.50.0 or later.
- Git CLI (the extension shells out to
git) and an open workspace folder that
is a valid Git repository with an origin remote.
- Reachable Jira and Jenkins endpoints plus credentials that support HTTP Basic
authentication.
- Jenkins jobs are expected to follow the pattern
https://jenkins.ycloud.com/job/test/job/<repoName>; adjust the source if
your setup differs.
Usage
- Press
⌘⇧P / Ctrl+Shift+P, run Workauto: 打开主界面, and wait for the
dashboard to load.
- Config tab
- Fill in
jiraUrl, project, username, password.
- Provide
jenkinsUser and jenkinsToken (API token or password) so that
build requests can be authenticated.
- Click 保存; values are written to
~/workstreamauto/config.json.
- Home tab
- Type a Jira number to prefill the commit message.
- Pick a build branch from the live Git branch list (current branch is
selected automatically).
- Hit 一键构建. The extension will:
- Validate staged changes and create a commit when a message is supplied.
- Execute the necessary Git operations (different flows for same-branch
vs cross-branch builds).
- Fetch the repo URL, inspect the last successful Jenkins build, and show
a modal if the branch differs.
- Trigger the Jenkins job and attach the resulting URL to the build step.
The Build Status panel tracks every sub-step (commit, push, checkout, etc.) and
displays errors inline so you can retry immediately.
Configuration Storage
Saved credentials and preferences live in ~/workstreamauto/config.json.
The file is plain JSON so treat it like any other secret (consider OS-level
encryption if you share the workstation).
Commands
workauto.helloWorld – surfaces the Workauto webview (labelled
Workauto: 打开主界面 in the UI).
Extension Settings
This extension does not contribute VS Code settings.json entries; configure it
through the built-in Config tab.
Known Issues / Limitations
- Jenkins host and job path are currently hard-coded to
https://jenkins.ycloud.com/job/test/job/<repoName>.
- Only the first workspace folder is inspected; multi-root workspaces are not
yet supported.
- Git credentials and Jenkins tokens are stored in plain text JSON.
- Jenkins jobs are only triggered; their log output and completion state are not
streamed back to the UI.
Release Notes
0.0.1
- Initial release containing the Home dashboard, Config tab, Jira lookup,
Git automation pipeline, last-build comparison modal, and Jenkins trigger
integration.
| |