Skip to content

Commit d82364d

Browse files
MrRefactoringMrRefactoring
committed
v2.19.1
1 parent 972c4ca commit d82364d

14 files changed

+358
-698
lines changed

‎CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Jira.js changelog
22

3+
### 2.19.1
4+
5+
- `setIssueProperty` method in `IssueProperties` API fixed. `propertyValue` parameter added.
6+
- logo fixed
7+
38
### 2.19.0
49

510
- Version 2, Version 3:

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div align="center">
2-
<img alt="Jira.js logo" src="https://svgshare.com/i/T6B.svg"/>
2+
<img alt="Jira.js logo" src="https://svgshare.com/i/uts.svg"/>
33

44
<a href="https://www.npmjs.com/package/jira.js"><img alt="NPM version" src="https://img.shields.io/npm/v/jira.js.svg?maxAge=3600&style=flat-square" /></a>
55
<a href="https://www.npmjs.com/package/jira.js"><img alt="NPM downloads per month" src="https://img.shields.io/npm/dm/jira.js.svg?maxAge=3600&style=flat-square" /></a>

‎examples/README.md

Lines changed: 39 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,79 @@
1-
# Jira.js usage examples
1+
# Jira.js Usage Examples
2+
3+
This guide provides examples of using the [`jira.js`](https://github.com/MrRefactoring/jira.js) library to interact with Jira's API. These examples will help you get started with common operations like creating a project, adding a task, adding a worklog, and retrieving all worklogs.
24

35
## Table of contents
46

5-
1. [Initial steps](#initial-steps)
6-
2. Examples
7-
1. [Basic example](#basic-example)
8-
2. [Add worklog example](#add-worklog-example)
9-
3. [Get all worklogs example](#get-all-worklogs-example)
7+
1. [Getting Started](#getting-started)
8+
2. [Examples](#examples)
9+
* [Basic Example](#basic-example)
10+
* [Add Worklog Example](#add-worklog-example)
11+
* [Get All Worklogs Example](#get-all-worklogs-example)
12+
13+
## Getting Started
1014

11-
## Initial steps
15+
Before you start running the examples, make sure to complete the following steps:
1216

13-
1. Install dependencies
17+
1. **Install Dependencies**: The examples require certain Node.js packages to run. Install these dependencies by running the command:
1418

15-
```shell
19+
```console
1620
npm i
1721
```
1822

19-
2. Specify `host`, `email` and `apiToken` variables in `src/credentials.ts` file
23+
2. **Setup Credentials:** The jira.js library uses your Jira's `host`, `email`, and `apiToken` to authenticate requests. Specify these in the `src/credentials.ts` file:
2024

21-
```ts
25+
```typescript
2226
const host = 'https://your-domain.atlassian.net';
2327
const email = 'YOUR_EMAIL';
2428
const apiToken = 'YOUR_API_TOKEN';
2529
```
2630

2731
## Examples
2832

29-
### Basic example
33+
Here are some examples of what you can do with `jira.js`:
34+
35+
### Basic Example
36+
37+
This example creates a new project and a new task in that project.
3038

31-
> ⚠️ Attention, the following behavior is performed:
32-
> 1. If you don't have any projects yet, then a new project is created with the `PROJECT` key, called `My Project`
33-
> 2. If you already have a project, it will create a new `task` named `My first issue` in the first project that comes along
39+
⚠️ **NOTE:** The script first checks if you have any existing projects.
40+
If you do, it creates a new task in the first project it finds.
41+
If you don't, it creates a new project with the key **PROJECT** and the name **My Project**,
42+
and then creates a task in that project.
3443

35-
To run the basic example, just run the `basic` script:
44+
To run this example, use the command:
3645

37-
```shell
46+
```console
3847
npm run basic
3948
```
4049

4150
---
4251

43-
### Add worklog example
52+
### Add Worklog Example
4453

45-
> ⚠️ Attention, the following behavior is performed:
46-
>
47-
> In the first project that comes along, a new task is created, and one new Workflow is added to it
54+
This example creates a new task in the first project it finds and adds a worklog to it.
4855

49-
> If you haven't created a project yet, follow the [basic example](#basic-example)
56+
⚠️ **NOTE:** If you don't have any existing projects, you should run the [Basic Example](#basic-example) first to create a project.
57+
One new Worklog will be added.
5058

51-
To add a `worklog` run the `addWorklog` script:
59+
To run this example, use the command:
5260

53-
```shell
61+
```console
5462
npm run addWorklog
5563
```
5664

5765
---
5866

59-
### Get all worklogs example
67+
### Get All Worklogs Example
6068

61-
> ⚠️ Attention, the following behavior is performed:
62-
>
63-
> The same as in [Add worklog example](#add-worklog-example), and will also get all the worklogs that have been added
69+
This example creates a new task, adds a worklog to it,
70+
and then retrieves all the worklogs that have been added to the task.
6471

65-
> If you haven't created a project yet, follow the [basic example](#basic-example)
72+
⚠️ **NOTE:** Similar to the Add Worklog Example, you should have an existing project before running this example.
73+
If you don't, run the Basic Example first.
6674

67-
To get all worklogs run the `getAllWorklogs` script:
75+
To run this example, use the command:
6876

69-
```shell
77+
```console
7078
npm run getAllWorklogs
7179
```

0 commit comments

Comments
 (0)