Skip to content

Release 0.0.3 #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
raphjaph merged 2 commits into from
Feb 4, 2025
Merged

Release 0.0.3 #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
078355e
Release 0.0.3
raphjaph Feb 4, 2025
2a78b72
Amend
raphjaph Feb 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,3 +95,12 @@ function App() {
);
}
```

### Publish release

- update `package.json` version
- update version in `docs/generateHtml.ts`
- update all dependencies (`bun update`)
- prepare the CHANGELOG
- open release PR on github
- `bun publish`
4 changes: 2 additions & 2 deletions bun.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions docs/generateHtml.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ function generateHtml() {
<div class="flex flex-col gap-2">
<div class="flex justify-between items-center">
<div>
<h1 class="text-2xl font-bold">OrdAPI v0.0.2</h1>
<h1 class="text-2xl font-bold">OrdAPI v0.0.3</h1>
<p class="text-green-400 mt-1">Simple TypeScript client for ord API.</p>
</div>
<div class="flex gap-4">
Expand Down Expand Up @@ -210,4 +210,4 @@ function generateHtml() {
console.log('Documentation HTML generated successfully!');
}

generateHtml();
generateHtml();
9 changes: 9 additions & 0 deletions justfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 3 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ordapi",
"version": "0.0.2",
"version": "0.0.3",
"license": "CC0-1.0",
"keywords": [
"ordinals",
Expand Down Expand Up @@ -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",
Expand Down