Add a changelog and prepare for registration

JuliaWeb · Jan 28, 2024 · 3c51f30 · 3c51f30 · JamesWrigley · Jan 28, 2024
1 parent db00b66
commit 3c51f30
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 5 deletions.
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -1,3 +1,4 @@
 build/
 site/
 src/examples.md
+src/generated_changelog.md
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -1,4 +1,5 @@
 [deps]
+Changelog = "5217a498-cd5d-4ec6-b8c2-9b85a09b6e3e"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 LibSSH = "00483490-30f8-4353-8aba-35b82f51f4d0"
 Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"

diff --git a/docs/make.jl b/docs/make.jl
@@ -1,5 +1,6 @@
 import Revise
 import Literate
+import Changelog
 import Documenter
 import Documenter: Remotes, makedocs, deploydocs
 
@@ -63,6 +64,14 @@ Literate.markdown(joinpath(@__DIR__, "src/examples.jl"),
                   execute=true,
                   flavor=Literate.DocumenterFlavor())
 
+# Build the changelog
+Changelog.generate(
+    Changelog.Documenter(),
+    joinpath(@__DIR__, "src/changelog.md"),
+    joinpath(@__DIR__, "src/generated_changelog.md"),
+    repo="JamesWrigley/LibSSH.jl"
+)
+
 # Build and deploy the docs
 makedocs(;
          repo = Remotes.GitHub("JamesWrigley", "LibSSH.jl"),
@@ -78,6 +87,7 @@ makedocs(;
              "server_support.md",
              "utilities.md",
              "bindings.md",
+             "generated_changelog.md",
              "contributing.md"
          ],
          modules = [LibSSH],

diff --git a/docs/src/changelog.md b/docs/src/changelog.md
@@ -0,0 +1,14 @@
+# Changelog
+
+This documents notable changes in LibSSH.jl. The format is based on [Keep a
+Changelog](https://keepachangelog.com).
+
+## [v0.1.0] - 2024-01-28
+
+The initial release 🎉 ✨
+
+### Added
+
+- Basic client support, and high-level wrappers for some [Channel
+  operations](@ref).
+- A [Demo server](@ref) for testing SSH clients.
diff --git a/docs/src/contributing.md b/docs/src/contributing.md
@@ -34,9 +34,9 @@ Here's a suggested workflow if you're writing documentation:
 ```julia-repl
 pkg> activate docs
 julia> using LiveServer
-# Skip monitoring examples.md because that's generated automatically, otherwise
-# we'd get into an infinite loop.
-julia> servedocs(; include_dirs=["src"], skip_files=["docs/src/examples.md"])
+# Note that we ignore automatically generated files, otherwise we'd end up in an
+# infinite loop.
+julia> servedocs(; include_dirs=["src"], skip_files=["docs/src/examples.md", "docs/src/generated_changelog.md"])
 ```
 
 This will start a server with

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -25,9 +25,9 @@ ssh.lib_version()
 
 ## Installation
 
-LibSSH.jl isn't registered yet, so for now you'll have to add it from Github:
+LibSSH.jl is available in the general registry:
 ```julia-repl
-pkg> add https://github.com/JamesWrigley/LibSSH.jl
+pkg> add LibSSH
 ```
 
 ## Limitations