Bắt đầu

Guide 4: Jira Software for developers

Jira for developers: 6 steps for getting started

Step 1 – Join the team’s project

In Jira Software, teams often work in individual projects and visualize work-in-progress on boards.

  1. To find your teams project, click the Jira home icon in the top-left corner.
  2. Nhấp vào Projects
  3. Select your team name.
PRO TIP
You can also use keyboard shortcuts in Jira. Press g và p to go to the projects screen. Press ? at any time to view a list of all Jira shortcuts.

Step 2 – Find work in your project

There are multiple views of work items in Jira (also called Issues), the most popular ones are: the Board, the Backlog and Search.PRO TIP

PRO TIP
If you are working across multiple projects, you can use Search to see a list of issues across multiple projects. Learn more about search.

Scrum

  1. In scrum projects issues are located on the backlog and on the sprint board.
  2. Find your teams current sprint board by clicking the Active Sprint or Boards menu item on the left. Issues are represented by cards on the board. You can filter the board to find the issues assigned to you in the current sprint.
  3. The backlog screen shows issues assigned in the current and in future sprints. Issues not assigned to a sprint are located in the backlog. Learn more about working in Scrum projects.

Kanban

In kanban projects all issues reside on the board. New issues are created in the To Do column. Each additional column represents a specific activity that make up your team’s “workflow”. Learn more about working in Kanban boards.

PRO TIP
Download the Jira for Mac app for a simpler, faster and native Jira experience

Step 3 – Create new issues

There are multiple ways to create new issues in Jira. The first step is to find out which project type your team is using. 

If your team is using the next-gen project you will see a note on the bottom left of your project screen.

Next-gen

Next-gen projects have a redesigned, and simplified Jira experience.

  • If you are working on a Scrum project in next-gen, you can create new issues on the backlog screen by clicking the create issue link or by pressing c.
  • If you are working on a Kanban project, you can create new issues in the To Do column on your project Board by clicking the Create Issue link or by pressing c.

Any new issue you create will default to a Story issue type, you can change the type by clicking the Story icon (  ). If you are not sure which type is the right one, you can learn more here

Classic

Classic projects have all the features and options that Jira is known for.

  • If you are working on a Scrum project in classic, you can create new issues on the backlog screen by clicking the create issue link or by pressing c.
  • If you are working on a Kanban project, you can create new issues from the board screen by clicking the create issue button on the left navigation or by pressing c.

Any new issue you create will default to a Story issue type, you can change the type by clicking the Story icon ( ). If you are not sure which type is the right one, you can learn more here

PRO TIP
Many users create new Jira issues via integrations. The most popular app to create new issues is Slack. If your team uses Slack you can get started here.

Step 4 – Organize your work

A subtask can be created for an issue to either split the issue into smaller chunks, or to allow various aspects of an issue to be assigned to different people. Simply click on the subtask or child issue button when viewing a Jira issue.

Issue linking allows you to create an association between two existing issues. You can also link to create an association between an issue and a Confluence page.

Add any additional descriptions to the issue. The Atlassian editor supports markdown formatting which makes it quick and easy to add headings, code blocks, and more. (shortcut / in editor)

Learn more about markdown in Jira

Step 5 – Start work

  1. Assign work to yourself (shortcut i)
  2. Start coding, if your administrator has connected your code repository you can create a new branch in your projects repo from the Jira issue screen. 

    When you reference your issue key(s) in your development work (branches, commits, PRs) information from your connected development tools will be displayed on the issue. Tìm hiểu thêm.
  3. Move status to in-progress status.
PRO TIP
Add Jira to VSCode and enjoy useful automation features in your IDE. Get the Jira extension on the VSCode marketplace.

Step 6 – Complete work

  1. Merge your code back into master by opening a pull request.
  2. Change the status to done :tada:
PRO TIP
If your CI/CD tools are connected to Jira build and deployment information will automatically be added to the Jira issue. Learn more about CI/CD and Jira.

If you forget to update the Jira status you can now fix it quickly on the train ride to work. Get the Jira mobile app

Get started with Developer Tool integrations

Why link code to Jira issues?

Use case 1: Visibility into your development pipeline from Jira

The development panel on the Jira issue screen summarizes key development  information such as branches, commits and PRs for each issue. This improves cross-collaboration between teams like engineering, QA and operations. Learn more about development information in Jira.

Deployment panel

Use case 2: Automate Jira via code changes

Instead of manually updating the status of an issue after creating branches or merging pull requests you can configure triggers in your workflow to automatically transition issues when certain events occur in your development tools. Learn more about automation with Git information.

Use case 3: Search Jira using development information

Get deeper insight into your complete software pipeline from within Jira Software. You can create powerful views across your full software pipeline from backlog to production. Query Jira data based on Git, build or deployment information. Learn more about the Jira Querying Language (JQL).

deploymentEnvironmentType ~ production AND development[pullrequests].open >= 1


How to link code to Jira issues

When development tools are integrated with Jira Software, you simply add the Jira issue key in your development tool to link information. Below is a handy table of how to link Jira issues from your development tool:

Hình thứcHowExample
BranchBranches are linked if the issue key is included in the branch name.PROD-1274-redesign-of-login-screen
CommitCommits are linked if the issue key is included in the commit message. PROD-1274 Fix eslint error and update tests
PRPull requests are linked if the issue key is included in the pull request’s title or in the source branch name.PROD-1274-redesign-of-login-screen

Read more about linking issues to code

PRO TIP
If you are using Bitbucket with Jira, you can create a new Branch from the Issue Screen which creates a branch in Bitbucket, and links it in Jira.

Set up the Bitbucket integration

Learn how to set up the Bitbucket integration

Note: You need to have Jira administrator permissions to set up the integration.

Set up the GitHub integration

Learn how to set up the GitHub integration
Learn how to set up the GitHub Enterprise integration

Note: You need to have Jira administrator permissions to set up the integration.

Set up the GitLab integration

Lean how to set up the GitLab integration

Note: You need to have Jira administrator permissions to set up the integration.

PRO TIP
Add Jira and Bitbucket to VSCode and enjoy useful automation features in your IDE. Get the Jira extension on the VSCode marketplace.
VSCode

How to use Jira for Continuous Integration and Delivery

Why you should connect your CI/CD tools

For software teams that practice continuous integration and delivery, developers now own and maintain their own pipeline. This puts developers in control of how code gets shipped to customers. This awesome power also comes with new challenges. 

Jira Software can help you manage your work from backlog all the way to customer release with no extra effort. This guide explains how Jira’s functionality and integration can provide a solution.

Here are three use cases of how Jira helps teams practicing CI/CD:

Use case 1: Foster a culture of collaboration across DevOps teams

With better information sharing between tools in your delivery stack, you can also improve cross-collaboration between teams. How many times have you asked someone whether or not a feature was deployed?

Dev tools ticketview

Now, you can easily look at any Jira issue and see what environment your code is on. This creates a much more open, collaborative, and self-service environment. Teams such as QA and operations can collaborate in the software teams sprint. With cross-cutting workflow between QA and developers, you can create a rapid feedback loop for testing at any point of your development process. Learn more about development information in Jira.

Use case 2: Reduce your change failure rate by building workflows around your deployment pipeline

If you team is practicing CI/CD and runs their own services, then that means you will need to invest in operating those services and maintaining a healthy pipeline. As with any complex system, failures are bound to happen, therefore it’s really a matter of how frequently this happens and how fast you can respond when it does. Enter the DevOps side of the equation – bringing operations and development closer together.

Use case 3: Deploy more often with better insight into what’s ready for release

The Jira Release Hub displays the teams progress towards the next version or product increment. If you connect your developer tools, commit, PR and build information related to a release version is also shown. This can help you spot potential development issues that could cause problems for a planned release. Learn more about release management in Jira.

Release hub

How to get started

1. Link your code repository

Before adding CI/CD integrations, make sure your code repository is connected with Jira. Jira Software uses information from your code repository to associate Jira issues with builds and deployments. Learn more about integrations with code repositories.

Note: The easiest way to associate a Jira issue with information in your CI/CD tool is to add the Jira Issue Key to the Commit Message. Example: “TEST-2332”

2. Add your build and deployment tool

Bitbucket Pipelines for Jira
Connect Bitbucket Pipelines to Jira Software and get visibility into build and deployment information from Jira.
CircleCl for Jira
See issue progress at a glance by adding build + deploy status from CircleCl to Jira

Azure Pipelines for Jira
Instantly track development for Jira issues by adding information from Azure Pipelines

Octopus Deploy for Jira
Tighten the feedback loop in your CI/CD pipeline from issue creation through to release by integrating Octopus Deploy with Jira

Travis for Jira
Provides real-time Travis CI build information in Jira, giving visibility into your delivery pipeline

Jenkins for Jira
Connect your Jenkins server to Jira Software Cloud for more visibility into your development pipeline.

TeamCity for Jira
Instantly view build information in JIRA. Remotely trigger your builds in TeamCity. Track numbers of builds fixing reported.

3. Configure your pipeline

 Configuration sets
BitbucketNo action required – Bitbucket Pipelines will automatically pick up any related Jira issues when that pipeline is run.
Jenkins1.Go into a specific pipeline in Jenkins 
2. From the left-hand menu, select Pipeline Syntax.
3. In the Snippet Generator, select jiraSendDeploymentInfo or jiraSendBuildInfo from the dropdown list of Sample Steps and fill in the relevant details.
4. Select Generate Pipeline Script and copy/paste the output into your Jenkinsfile on the relevant Repository you are using. This will be used to notify Jira when you run that pipeline on that repo.See here for an example snippet.
CircleCI1. Make sure that you are using version 2.1 at the top of your .circleci/config.yml file.
2. If you do not already have pipelines enabled, go to Project Settings -> Build Settings -> Advanced Settings and enable them.
3. Create an API token for build information retrieval, go to Project Settings -> Permissions -> API Permissions and create a token with Scope: all. Copy the token.
4. To allow the integration to then use that key, go to Project Settings -> Build Settings -> Environment Variables and add a variable named CIRCLE_TOKEN with the value being the token you just made.
5. Add the orb stanza, invoking the Jira orb.
6. Use the Jira orb in a step.See here for an example snippet.
OthersFor other tools please refer to the information listed on the marketplace listing. Find more information.

VI