From 078355edd9423a5ce82f2ce5abd9944dc32dcb49 Mon Sep 17 00:00:00 2001 From: raphjaph Date: Tue, 4 Feb 2025 13:52:41 +0100 Subject: [PATCH 1/2] Release 0.0.3 --- CHANGELOG.md | 19 +++++++++++++++++++ README.md | 7 +++++++ bun.lock | 4 ++-- docs/generateHtml.ts | 4 ++-- justfile | 9 +++++++++ package.json | 6 +++--- 6 files changed, 42 insertions(+), 7 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..2688b92 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,19 @@ +Changelog +========= + +[0.0.3](https://github.com/raphjaph/ordapi/releases/tag/0.0.3) - 2025-02-04 +--------------------------------------------------------------------------- + +### Added +- Add name to Docs workflow (#16) +- Add documentation (#14) +- Add License and badges (#13) +- Remove unnecessary awaits (#12) +- Adding remaining endpoints (#11) +- Publish 0.0.2 (#8) +- Add installation and usage instructions to README (#7) +- Add block-related endpoints (#5) +- Add CI (#6) +- Init TypeScript library (#2) +- Fix README (#1) +- Initial commit diff --git a/README.md b/README.md index 63ad8c1..ab8e95d 100644 --- a/README.md +++ b/README.md @@ -95,3 +95,10 @@ function App() { ); } ``` + +### Publish release + +- update `package.json` version +- update version in `docs/generateHtml.ts` +- update all dependencies (`bun update`) +- prepare the CHANGELOG diff --git a/bun.lock b/bun.lock index 58ba2e2..cfd0127 100644 --- a/bun.lock +++ b/bun.lock @@ -4,11 +4,11 @@ "": { "name": "ordapi", "dependencies": { - "typescript-eslint": "^8.22.0", + "typescript-eslint": "^8.23.0", "zod": "^3.24.1", }, "devDependencies": { - "@types/bun": "^1.2.1", + "@types/bun": "^1.2.2", "@types/react": "^19.0.8", "@types/react-dom": "^19.0.3", "react": "^19.0.0", diff --git a/docs/generateHtml.ts b/docs/generateHtml.ts index 9c7acd5..d7d525f 100644 --- a/docs/generateHtml.ts +++ b/docs/generateHtml.ts @@ -120,7 +120,7 @@ function generateHtml() {
-

OrdAPI v0.0.2

+

OrdAPI v0.0.3

Simple TypeScript client for ord API.

@@ -210,4 +210,4 @@ function generateHtml() { console.log('Documentation HTML generated successfully!'); } -generateHtml(); \ No newline at end of file +generateHtml(); diff --git a/justfile b/justfile index 0449ce8..4996143 100644 --- a/justfile +++ b/justfile @@ -18,5 +18,14 @@ docs: ci: install lint test +prepare-changelog revision='master': + #!/usr/bin/env bash + set -euxo pipefail + git checkout {{ revision }} + git pull origin {{ revision }} + echo >> CHANGELOG.md + git log --pretty='format:- %s' >> CHANGELOG.md + $EDITOR CHANGELOG.md + publish: bun publish diff --git a/package.json b/package.json index 4d77f99..c9da306 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "ordapi", - "version": "0.0.2", + "version": "0.0.3", "license": "CC0-1.0", "keywords": [ "ordinals", @@ -30,11 +30,11 @@ } }, "dependencies": { - "typescript-eslint": "^8.22.0", + "typescript-eslint": "^8.23.0", "zod": "^3.24.1" }, "devDependencies": { - "@types/bun": "^1.2.1", + "@types/bun": "^1.2.2", "@types/react": "^19.0.8", "@types/react-dom": "^19.0.3", "react": "^19.0.0", From 2a78b729421a2dfdf2466ee1ff3c0d9f1110a9c0 Mon Sep 17 00:00:00 2001 From: raphjaph Date: Tue, 4 Feb 2025 13:53:24 +0100 Subject: [PATCH 2/2] Amend --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index ab8e95d..bf2c4a8 100644 --- a/README.md +++ b/README.md @@ -102,3 +102,5 @@ function App() { - update version in `docs/generateHtml.ts` - update all dependencies (`bun update`) - prepare the CHANGELOG +- open release PR on github +- `bun publish`