Skip to content

Commit 84ad1cd

Browse files
ComfortablyCodingComfortablyCoding
authored
feat: v4 (#42)
* refactor: cleanup and move to esm * chore: update deps, configs and tests * fix(workflows): actions are not under `.github` * fix(setup action): pnpm version is not specified * chore: update ignore files * chore(jsdoc): add a link corresponding API doc for functions * chore(route): update typing for client * fix(comment): add missing threaded endpoints * chore(setToken): add additional space to jsdoc for consistency * docs: remove manual docs * doc: add auto generated API * unify naming and add missing routes * add version support * remove index route import * remove version fro prefixUrl * fix token not being set with setToken * auto snakeCase body keys * Rename params to options and utilize query over params * export routes under default * remove leading route slash * move to ofetch, add rate limiting and snake_case keys * add tests * move route top level * add docs * remove pnpm-workspace * update prettier rule * add required version prefix to auth routes * fix version not being passed to routes * fix token not acknowledged * improve error format * add jsdoc for createClickup * utilize oidc tokens for publish * setup docs deploy * update docs url to gh pages * shel is required for composite actions * only build esm * add changelog.md * Improve doc sidebar * fix doc note display
1 parent b3a6d86 commit 84ad1cd

75 files changed

Lines changed: 7273 additions & 17861 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.eslintignore‎

Lines changed: 0 additions & 45 deletions
This file was deleted.

‎.eslintrc.json‎

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎.github/actions/setup/action.yml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Setup
2+
3+
runs:
4+
using: composite
5+
steps:
6+
- name: setup Node
7+
uses: actions/setup-node@v4
8+
with:
9+
node-version: 24
10+
registry-url: https://registry.npmjs.org/
11+
12+
# Trusted publishing requires npm 11.5.1 or later is installed
13+
- name: update npm
14+
# required for composite actions
15+
shell: bash
16+
run: npm install -g npm@11.5.1
17+
18+
- name: setup pnpm
19+
uses: pnpm/action-setup@v3
20+
with:
21+
run_install: false
22+
version: 10
23+
24+
- name: install dependencies
25+
# required for composite actions
26+
shell: bash
27+
run: pnpm install

‎.github/workflows/docs.yml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Deploy Docs
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
# Required for pushing content to pages
12+
pages: write
13+
id-token: write
14+
15+
concurrency:
16+
group: "pages"
17+
cancel-in-progress: false
18+
19+
jobs:
20+
build:
21+
runs-on: ubuntu-latest
22+
steps:
23+
- name: checkout
24+
uses: actions/checkout@v4
25+
26+
- name: setup environment
27+
uses: ./.github/actions/setup
28+
29+
- name: setup page
30+
uses: actions/configure-pages@v5
31+
32+
- name: build docs
33+
run: pnpm run docs:deploy
34+
35+
- name: upload
36+
uses: actions/upload-pages-artifact@v3
37+
with:
38+
path: ./docs/.vitepress/dist
39+
40+
# Deployment job
41+
deploy:
42+
environment:
43+
name: github-pages
44+
url: ${{ steps.deployment.outputs.page_url }}
45+
runs-on: ubuntu-latest
46+
needs: build
47+
steps:
48+
- name: deploy
49+
id: deployment
50+
uses: actions/deploy-pages@v4

‎.github/workflows/npm-publish.yml‎

Lines changed: 0 additions & 33 deletions
This file was deleted.

‎.github/workflows/pr-test.yml‎

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
1-
name: PR Test
1+
name: Test PR
2+
23
on: [pull_request]
4+
35
jobs:
4-
test-pr:
6+
test:
57
runs-on: ubuntu-latest
68
steps:
7-
- name: Checkout branch
8-
uses: actions/checkout@v2
9-
10-
- name: Install Node v16
11-
uses: actions/setup-node@v2
9+
- name: checkout
10+
uses: actions/checkout@v4
1211
with:
13-
node-version: '16.x'
14-
registry-url: 'https://registry.npmjs.org'
12+
fetch-depth: 0
1513

16-
- name: Clean install deps
17-
run: npm ci
14+
- name: setup
15+
uses: ./.github/actions/setup
1816

19-
- name: Run tests
20-
run: npm test
17+
- name: test
18+
run: pnpm test -- -- --changed origin/${{ github.base_ref }} --passWithNoTests

‎.github/workflows/publish.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Publish Package
2+
3+
permissions:
4+
id-token: write # Required for OIDC
5+
contents: read
6+
7+
on:
8+
release:
9+
types: [published]
10+
11+
jobs:
12+
publish:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: checkout
16+
uses: actions/checkout@v4
17+
18+
- name: setup environment
19+
uses: ./.github/actions/setup
20+
21+
- name: test
22+
run: pnpm test
23+
24+
- name: publish
25+
run: pnpm publish

‎.gitignore‎

Lines changed: 6 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
# Logs
22
logs
33
*.log
4-
npm-debug.log*
5-
yarn-debug.log*
6-
yarn-error.log*
74
lerna-debug.log*
85

96
# Diagnostic reports (https://nodejs.org/api/report.html)
@@ -15,90 +12,28 @@ pids
1512
*.seed
1613
*.pid.lock
1714

18-
# Directory for instrumented libs generated by jscoverage/JSCover
19-
lib-cov
20-
2115
# Coverage directory used by tools like istanbul
2216
coverage
23-
*.lcov
24-
25-
# nyc test coverage
26-
.nyc_output
27-
28-
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
29-
.grunt
30-
31-
# Bower dependency directory (https://bower.io/)
32-
bower_components
33-
34-
# node-waf configuration
35-
.lock-wscript
36-
37-
# Compiled binary addons (https://nodejs.org/api/addons.html)
38-
build/Release
3917

4018
# Dependency directories
4119
node_modules/
42-
jspm_packages/
43-
44-
# TypeScript v1 declaration files
45-
typings/
46-
47-
# TypeScript cache
48-
*.tsbuildinfo
49-
50-
# Optional npm cache directory
51-
.npm
5220

5321
# Optional eslint cache
5422
.eslintcache
5523

56-
# Microbundle cache
57-
.rpt2_cache/
58-
.rts2_cache_cjs/
59-
.rts2_cache_es/
60-
.rts2_cache_umd/
61-
62-
# Optional REPL history
63-
.node_repl_history
64-
6524
# Output of 'npm pack'
6625
*.tgz
6726

68-
# Yarn Integrity file
69-
.yarn-integrity
70-
7127
# dotenv environment variables file
7228
.env
7329
.env.test
7430

75-
# parcel-bundler cache (https://parceljs.org/)
76-
.cache
31+
# cache
32+
cache
7733

78-
# Next.js build output
79-
.next
80-
81-
# Nuxt.js build / generate output
82-
.nuxt
34+
# build
8335
dist
8436

85-
# Gatsby files
86-
.cache/
87-
# Comment in the public line in if your project uses Gatsby and *not* Next.js
88-
# https://nextjs.org/blog/next-9-1#public-directory-support
89-
# public
90-
91-
# vuepress build output
92-
.vuepress/dist
93-
94-
# Serverless directories
95-
.serverless/
96-
97-
# FuseBox cache
98-
.fusebox/
99-
100-
# DynamoDB Local files
101-
.dynamodb/
102-
103-
# TernJS port file
104-
.tern-port
37+
# autogen docs
38+
docs/api.md
39+
docs/changelog.md

0 commit comments

Comments
 (0)