Skip to content

Commit 2a6b490

Browse files
MrRefactoringMrRefactoring
authored
v5.1.1 (#385)
* ci improvements, dependencies updated * #381 commonjs fix (#382) * #381 commonjs fix * CHANGELOG added for v5.1.1 * #383 esm fix (#384)
1 parent ff4d9ed commit 2a6b490

File tree

8 files changed

+399
-377
lines changed

8 files changed

+399
-377
lines changed

‎.github/workflows/ci.yaml

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: CI
1+
name: 🛠️ CI
22

33
on:
44
push:
@@ -14,77 +14,77 @@ env:
1414

1515
jobs:
1616
build:
17-
name: Build
17+
name: 🏗️ Build
1818
runs-on: ubuntu-latest
1919
strategy:
2020
matrix:
2121
node-version: [20.x, 22.x]
2222
steps:
23-
- name: Checkout sources
23+
- name: 🔄 Checkout sources
2424
uses: actions/checkout@v4
25-
- name: Use Node.js ${{ matrix.node-version }}
25+
- name: ⚙️ Use Node.js ${{ matrix.node-version }}
2626
uses: actions/setup-node@v4
2727
with:
2828
node-version: ${{ matrix.node-version }}
29-
- name: Install pnpm
29+
- name: 📦 Install pnpm
3030
uses: pnpm/action-setup@v4
3131
with:
3232
version: ${{ env.PNPM_VERSION }}
33-
- name: Installing dependencies
33+
- name: 📌 Installing dependencies
3434
run: pnpm install --frozen-lockfile
35-
- name: Building sources
35+
- name: 🛠️ Building sources
3636
run: pnpm run build
3737

3838
lint:
39-
name: Lint Code
39+
name: 🔍 Lint Code
4040
needs: build
4141
runs-on: ubuntu-latest
4242
strategy:
4343
matrix:
4444
node-version: [20.x, 22.x]
4545
steps:
46-
- name: Checkout sources
46+
- name: 🔄 Checkout sources
4747
uses: actions/checkout@v4
48-
- name: Use Node.js ${{ matrix.node-version }}
48+
- name: ⚙️ Use Node.js ${{ matrix.node-version }}
4949
uses: actions/setup-node@v4
5050
with:
5151
node-version: ${{ matrix.node-version }}
52-
- name: Install pnpm
52+
- name: 📦 Install pnpm
5353
uses: pnpm/action-setup@v4
5454
with:
5555
version: ${{ env.PNPM_VERSION }}
56-
- name: Installing dependencies
56+
- name: 📌 Installing dependencies
5757
run: pnpm install --frozen-lockfile
58-
- name: Linting
58+
- name: ✨ Linting
5959
run: pnpm run lint
6060
env:
6161
CI: true
6262

6363
test_unit:
64-
name: Unit Tests
64+
name: 🧪 Unit Tests
6565
needs: build
6666
runs-on: ubuntu-latest
6767
strategy:
6868
matrix:
6969
node-version: [20.x, 22.x]
7070
steps:
71-
- name: Checkout sources
71+
- name: 🔄 Checkout sources
7272
uses: actions/checkout@v4
73-
- name: Use Node.js ${{ matrix.node-version }}
73+
- name: ⚙️ Use Node.js ${{ matrix.node-version }}
7474
uses: actions/setup-node@v4
7575
with:
7676
node-version: ${{ matrix.node-version }}
77-
- name: Install pnpm
77+
- name: 📦 Install pnpm
7878
uses: pnpm/action-setup@v4
7979
with:
8080
version: ${{ env.PNPM_VERSION }}
81-
- name: Installing dependencies
81+
- name: 📌 Installing dependencies
8282
run: pnpm install --frozen-lockfile
83-
- name: Running unit tests
83+
- name: 🚀 Running unit tests
8484
run: pnpm run test:unit
8585

8686
test_integration:
87-
name: Integration Tests
87+
name: 🧩 Integration Tests
8888
needs:
8989
- lint
9090
- test_unit
@@ -94,23 +94,23 @@ jobs:
9494
matrix:
9595
node-version: [20.x, 22.x]
9696
steps:
97-
- name: Checkout sources
97+
- name: 🔄 Checkout sources
9898
uses: actions/checkout@v4
99-
- name: Use Node.js ${{ matrix.node-version }}
99+
- name: ⚙️ Use Node.js ${{ matrix.node-version }}
100100
uses: actions/setup-node@v4
101101
with:
102102
node-version: ${{ matrix.node-version }}
103-
- name: Install pnpm
103+
- name: 📦 Install pnpm
104104
uses: pnpm/action-setup@v4
105105
with:
106106
version: ${{ env.PNPM_VERSION }}
107-
- name: Installing dependencies
107+
- name: 📌 Installing dependencies
108108
run: pnpm install --frozen-lockfile
109-
- name: Creating `.env` file
109+
- name: 📝 Creating `.env` file
110110
run: |
111111
touch .env
112112
echo HOST=${{ secrets.HOST }} >> .env
113113
echo EMAIL=${{ secrets.EMAIL }} >> .env
114114
echo API_TOKEN=${{ secrets.API_TOKEN }} >> .env
115-
- name: Running integration tests
115+
- name: 🚀 Running integration tests
116116
run: pnpm run test:integration

‎.github/workflows/publish-dev.yml

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,54 @@
1-
name: Publish to NPM Dev Channel
1+
name: 🚀 Publish to NPM Dev Channel
22

33
on:
44
workflow_dispatch
55

6+
env:
7+
NODE_VERSION: '20.x'
8+
PNPM_VERSION: '10'
9+
610
permissions:
711
contents: read
812

9-
1013
jobs:
1114
build-and-publish:
1215
runs-on: ubuntu-latest
1316

1417
steps:
15-
- name: Checkout code
18+
- name: 🔄 Checkout code
1619
uses: actions/checkout@v4
1720

18-
- name: Set up Node.js
21+
- name: ⚙️ Setup Node.js ${{ env.NODE_VERSION }}
1922
uses: actions/setup-node@v4
2023
with:
21-
node-version: 20
24+
node-version: ${{ env.NODE_VERSION }}
2225
registry-url: https://registry.npmjs.org/
2326

24-
- name: Install dependencies
25-
run: npm install
27+
- name: 📦 Install pnpm
28+
uses: pnpm/action-setup@v4
29+
with:
30+
version: ${{ env.PNPM_VERSION }}
31+
32+
- name: 📌 Install dependencies
33+
run: pnpm install --frozen-lockfile
2634

27-
- name: Build project
28-
run: npm run build
35+
- name: 🛠️ Run build
36+
run: pnpm run build
2937

30-
- name: Update package version
38+
- name: 🔖 Update package version
3139
id: update-version
3240
run: |
3341
CURRENT_VERSION=$(node -p "require('./package.json').version")
3442
TIMESTAMP=$(date -u +"%Y%m%d%H%M%S")
3543
NEW_VERSION="${CURRENT_VERSION}-dev${TIMESTAMP}"
36-
npm version --no-git-tag-version $NEW_VERSION
44+
pnpm version --no-git-tag-version $NEW_VERSION
3745
echo "New version: $NEW_VERSION"
3846
echo "NEW_VERSION=$NEW_VERSION" >> $GITHUB_ENV
3947
40-
- name: Update package-lock.json
41-
run: npm install
48+
- name: 🔄 Update package-lock.json
49+
run: pnpm install
4250

43-
- name: Publish to NPM Dev Channel
44-
run: npm publish --tag dev
51+
- name: 📤 Publish to NPM Dev Channel
52+
run: pnpm publish --tag dev --no-git-checks
4553
env:
4654
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

‎.github/workflows/publish.yml

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -13,69 +13,69 @@ permissions:
1313

1414
jobs:
1515
build-and-test:
16-
name: Build and Test
16+
name: 🏗️ Build and Test
1717
runs-on: ubuntu-latest
1818
steps:
19-
- name: Checkout repository
19+
- name: 🔄 Checkout repository
2020
uses: actions/checkout@v4
2121
with:
2222
fetch-depth: 0
2323

24-
- name: Setup Node.js ${{ env.NODE_VERSION }}
24+
- name: ⚙️ Setup Node.js ${{ env.NODE_VERSION }}
2525
uses: actions/setup-node@v4
2626
with:
2727
node-version: ${{ env.NODE_VERSION }}
2828

29-
- name: Install pnpm
29+
- name: 📦 Install pnpm
3030
uses: pnpm/action-setup@v4
3131
with:
3232
version: ${{ env.PNPM_VERSION }}
3333

34-
- name: Install dependencies
34+
- name: 📌 Install dependencies
3535
run: pnpm install --frozen-lockfile
3636

37-
- name: Run build
37+
- name: 🛠️ Run build
3838
run: pnpm run build
3939

40-
- name: Run lint
40+
- name: 🔍 Run lint
4141
run: pnpm run lint
4242
env:
4343
CI: true
4444

45-
- name: Run unit tests
45+
- name: 🧪 Run unit tests
4646
run: pnpm run test:unit
4747

48-
- name: Run integration tests
48+
- name: 🧩 Run integration tests
4949
run: pnpm run test:integration
5050
env:
5151
HOST: ${{ secrets.HOST }}
5252
EMAIL: ${{ secrets.EMAIL }}
5353
API_TOKEN: ${{ secrets.API_TOKEN }}
5454

5555
publish-package:
56-
name: Publish Package
56+
name: 🚀 Publish Package
5757
needs: build-and-test
5858
runs-on: ubuntu-latest
5959
permissions:
6060
contents: write
6161
steps:
62-
- name: Checkout repository
62+
- name: 🔄 Checkout repository
6363
uses: actions/checkout@v4
6464
with:
6565
fetch-depth: 0
6666

67-
- name: Setup Node.js ${{ env.NODE_VERSION }}
67+
- name: ⚙️ Setup Node.js ${{ env.NODE_VERSION }}
6868
uses: actions/setup-node@v4
6969
with:
7070
node-version: ${{ env.NODE_VERSION }}
7171
registry-url: 'https://registry.npmjs.org'
7272

73-
- name: Install pnpm
73+
- name: 📦 Install pnpm
7474
uses: pnpm/action-setup@v4
7575
with:
7676
version: ${{ env.PNPM_VERSION }}
7777

78-
- name: Get and validate version
78+
- name: 🔖 Get and validate version
7979
id: version
8080
run: |
8181
if [[ $GITHUB_REF == refs/tags/v* ]]; then
@@ -103,47 +103,48 @@ jobs:
103103
env:
104104
GITHUB_TOKEN: ${{ secrets.PAT }}
105105

106-
- name: Install dependencies
106+
- name: 📌 Install dependencies
107107
run: pnpm install --frozen-lockfile
108108

109-
- name: Build package
109+
- name: 🛠️ Build package
110110
run: pnpm run build
111111

112-
- name: Publish to NPM
112+
- name: 📤 Publish to NPM
113113
run: pnpm publish --no-git-checks
114114
env:
115115
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
116116

117117
deploy-documentation:
118-
name: Deploy Documentation
118+
name: 📚 Deploy Documentation
119119
needs: publish-package
120120
runs-on: ubuntu-latest
121121
steps:
122-
- name: Checkout repository
122+
- name: 🔄 Checkout repository
123123
uses: actions/checkout@v4
124124
with:
125125
ref: master
126126

127-
- name: Setup Node.js ${{ env.NODE_VERSION }}
127+
- name: ⚙️ Setup Node.js ${{ env.NODE_VERSION }}
128128
uses: actions/setup-node@v4
129129
with:
130130
node-version: ${{ env.NODE_VERSION }}
131131

132-
- name: Install pnpm
132+
- name: 📦 Install pnpm
133133
uses: pnpm/action-setup@v4
134134
with:
135135
version: ${{ env.PNPM_VERSION }}
136136

137-
- name: Install dependencies
137+
- name: 📌 Install dependencies
138138
run: pnpm install --frozen-lockfile
139139

140-
- name: Generate documentation
140+
- name: 📝 Generate documentation
141141
run: pnpm run doc
142142

143-
- name: Deploy to docs branch
143+
- name: 🚀 Deploy to docs branch
144144
uses: JamesIves/github-pages-deploy-action@v4
145145
with:
146146
branch: docs
147147
folder: docs
148148
clean: true
149+
token: '${{ secrets.PAT }}'
149150
commit-message: "docs: Update documentation for v${{ needs.publish-package.outputs.version }} [skip ci]"

‎CHANGELOG.md

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

3+
## 5.1.1
4+
5+
- Fixing CommonJS requiring. Thanks to solshark ([solshark](https://github.com/solshark)) for reporting this issue ([#381](https://github.com/MrRefactoring/jira.js/issues/381))
6+
- Fixing ESM imports in TypeScript declarations. Thanks to Alex Grand ([Arilas](https://github.com/Arilas)) for reporting this issue ([#383](https://github.com/MrRefactoring/jira.js/issues/383))
7+
---
8+
- **Special thanks to [GervinFung](https://github.com/GervinFung) for the npm package [`ts-add-js-extension`](https://github.com/GervinFung/ts-add-js-extension), which helps resolve TypeScript ESM import paths.**
9+
310
## 5.1.0
411

512
- Version 2 Client

0 commit comments

Comments
 (0)