Skip to content

Final nits before first release #72

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
dschrempf merged 2 commits into from
Jul 20, 2026
Merged

Final nits before first release #72

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
532b890
Final nits before first release
dschrempf Jul 20, 2026
a6e8b01
Add upstream issues for remaining TODO items
dschrempf Jul 20, 2026
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
16 changes: 0 additions & 16 deletions dev/release-notes-0.1.0.0.md
View file
Open in desktop

This file was deleted.

16 changes: 6 additions & 10 deletions dev/release-process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@
* [ ] Set the version number
* [ ] Set the release date (UTC)

* [ ] Prepare release notes
* [ ] Ensure `cabal check` is green

## GitHub
## Git

* [ ] Ensure the changes above land on `main`

Expand All @@ -63,18 +63,14 @@
$ git push origin "${TAG}"
```

* [ ] [Create a new GitHub release](https://github.com/well-typed/libclang-bindings/releases/new)
* [ ] Select tag
* [ ] Target: `main`
* [ ] Release title: `Release ${VERSION}`
* [ ] Release notes: (paste release notes, formatted for GitHub Markdown)
* [ ] Publish release

## Hackage

* [ ] Run `cabal check`

TBD
* [ ] Release to Hackage

* [ ] Manually create documentation with `cabal-install` HEAD (which contains a
fix required for Haddocks of re-exports) and upload it

## Preparation for next release

Expand Down
2 changes: 1 addition & 1 deletion libclang-bindings/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,4 @@

## 0.1.0-alpha -- 2026-02-06

* First version. Released on an unsuspecting world.
* Release candidate.
4 changes: 3 additions & 1 deletion libclang-bindings/src/Clang/HighLevel/Diagnostics.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,9 @@ data FixIt = FixIt {
}
deriving stock (Show, Eq)

-- TODO: Probably separate into Info/Warning/Error (issue #175).
-- TODO <https://github.com/well-typed/libclang-bindings/issues/73>
--
-- Probably separate into Info/Warning/Error (issue #175).
diagnosticIsError :: Diagnostic -> Bool
diagnosticIsError diag =
case fromSimpleEnum (diagnosticSeverity diag) of
Expand Down
6 changes: 4 additions & 2 deletions libclang-bindings/src/Clang/Internal/ByValue.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,8 +185,10 @@ instance HasKnownSize tag => Preallocate (OnHaskellHeap tag) where

-- | Preallocate two values
--
-- TODO: It would be nice to generalize this, but I can't quite figure out how
-- without introducing a ton of machinery.
-- TODO <https://github.com/well-typed/libclang-bindings/issues/74>
--
-- It would be nice to generalize this, but I can't quite figure out how without
-- introducing a ton of machinery.
preallocatePair :: forall a b r.
(Preallocate a, Preallocate b)
=> (Writing a -> Writing b -> IO r)
Expand Down
Loading