Prepare v0.1.0 release#3
Merged
Merged
Conversation
Document how to install scribe via `opam pin` against a Git tag, in preparation for the v0.1.0 release. scribe is not published to the opam repository; pinning the tag is the supported installation path. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Add `(version 0.1.0)` to dune-project and regenerate scribe.opam so the package reports version 0.1.0 (instead of the pin default ~dev) when installed via `opam pin`. This keeps downstream version constraints such as `(scribe (>= 0.1.0))` satisfiable. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Plain fences for the `(libraries ...)` snippets; `lisp` highlighting was misleading for dune syntax. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
henrylee97
added
documentation
The `(libraries scribe scribe.sinks)` line now lives in the Installation section; drop the duplicate from Quick Start so it leads straight into the usage example. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Prepares the first public release,
v0.1.0. scribe is distributed via Git tags +opam pin(no opam-repository /dune-release).Installationsection to the README documentingopam pinagainst a Git tag (pin-latest and pin-specific-version), plus the dune(libraries scribe scribe.sinks)line.0.1.0via(version 0.1.0)in dune-project and regeneratescribe.opam, so pinned installs reportscribe.0.1.0instead of the pin default~devand downstream constraints like(scribe (>= 0.1.0))stay satisfiable.Verification
dune build✅dune runtest✅dune build @fmt✅dune build @install✅Release steps (after merge)
v0.1.0targeting the merge commit — this creates thev0.1.0tag.opam pin add scribe "https://github.com/sambyeol/scribe.git#v0.1.0"(or the pin-latest snippet in the README), which resolves toscribe.0.1.0.