README
¶
story start
Start working on a new story.
Usage
story start [-base=BASE] [-no_branch] [-push]
Description
This command shall be used when the developer wants to start working on a new story.
Unless -no_branch is specified, the user is asked to insert
the branch name to be used for the branch holding the story commits.
The branch of the given name is created on top of the trunk branch
and checked out. A custom base branch can be set by using -base.
The story branch is then pushed in case -push is specified.
Steps
The command goes through the following steps:
- Fetch startable stories from the issue tracker.
- Prompt the user to select a story.
- Prompt the user to insert the story branch slug unless
no_branchis set. - In case a non-empty branch slug is inserted, create the specified story branch on top of trunk. The remote repository is fetched to make sure the base branch is up to date before the story branch is created.
- Add the user among the story owners.
- Start the story in the issue tracker.
- Push the story branch in case
-pushis set.
Documentation
¶
Overview ¶
Start working on a new story.
story start [-base=BASE] [-no_branch] [-push]
Description ¶
This command shall be used when the developer wants to start working on a new story.
Unless -no_branch is specified, the user is asked to insert the branch name to be used for the branch holding the story commits. The branch of the given name is created on top of the trunk branch and checked out. A custom base branch can be set by using -base. The story branch is then pushed in case -push is specified.
Steps ¶
The command goes through the following steps:
- Fetch startable stories from the issue tracker.
- Prompt the user to select a story.
- Prompt the user to insert the story branch slug unless -no_branch is set.
- In case a non-empty branch slug is inserted, create the specified story branch on top of trunk. The remote repository is fetched to make sure the base branch is up to date before the story branch is created.
- Add the user among the story owners.
- Start the story in the issue tracker.
- Push the story branch in case -push is set.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var Command = &gocli.Command{
UsageLine: "start [-base=BASE] [-no_branch] [-push]",
Short: "start a new story",
Long: `
Start a new issue tracker story.
The user is shown the list of stories that can be started.
When they choose one, they are assigned to that story and the story
is started in the issue tracker.
Unless -no_branch is specified, the user is asked to insert
the branch name to be used for the branch holding the story commits.
The branch of the given name is created on top of the trunk branch
and checked out. A custom base branch can be set by using -base.
The story branch is then pushed in case -push is specified.
`,
Action: run,
}
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files