Release 1.0.0

JuliaDocs · Jun 3, 2024 · 5bcdd2b · 5bcdd2b · goerz · Jun 3, 2024
1 parent 09bffa2
commit 5bcdd2b
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 12 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -37,10 +37,10 @@ jobs:
             arch: x86
     steps:
       - uses: actions/checkout@v4
-      - uses: julia-actions/setup-julia@v1
+      - uses: julia-actions/setup-julia@v2
         with:
           version: ${{ matrix.version }}
-      - uses: julia-actions/cache@v1
+      - uses: julia-actions/cache@v2
       - name: "Instantiate test environment"
         shell: julia --color=yes --project=test {0}
         run: |
@@ -56,18 +56,19 @@ jobs:
       - name: "Summarize coverage"
         run: julia --project=test -L devrepl.jl -e 'display(show_coverage())'
       - uses: julia-actions/julia-processcoverage@v1
-      - uses: codecov/codecov-action@v3
+      - uses: codecov/codecov-action@v4
         with:
-          files: lcov.info
+          file: lcov.info
+          token: ${{ secrets.CODECOV_TOKEN }}
   testoldest:
     name: Test Lower Compat Bounds
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: julia-actions/setup-julia@v1
+      - uses: julia-actions/setup-julia@v2
         with:
           version: 1.6
-      - uses: julia-actions/cache@v1
+      - uses: julia-actions/cache@v2
       - name: "Instantiate test environment"
         shell: julia --color=yes --project=test {0}
         run: |
@@ -90,7 +91,7 @@ jobs:
       pages: write
     steps:
       - uses: actions/checkout@v4
-      - uses: julia-actions/setup-julia@v1
+      - uses: julia-actions/setup-julia@v2
         with:
           version: '1'
       - name: "Instantiate build environment"
@@ -106,7 +107,7 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           name: doc-inventories-docs
           path: docs/build/
@@ -115,7 +116,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: julia-actions/setup-julia@v1
+      - uses: julia-actions/setup-julia@v2
         with:
           version: '1'
       - name: Install JuliaFormatter and format

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,8 @@
+# Release Notes
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Version 1.0.0 - 2024-06-03
+
+* Initial stable release
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "DocInventories"
 uuid = "43dc2714-ed3b-44b5-b226-857eda1aa7de"
 authors = ["Michael Goerz <[email protected]>"]
-version = "0.4.1"
+version = "1.0.0"
 
 [deps]
 CodecZlib = "944b1d66-785c-5afd-91f1-9de20f533193"

diff --git a/docs/make.jl b/docs/make.jl
@@ -12,6 +12,7 @@ GITHUB = "https://github.com/goerz/DocInventories.jl"
 links = InterLinks(
     "Julia" => (
         "https://docs.julialang.org/en/v1/",
+        "https://docs.julialang.org/en/v1/objects.inv",
         joinpath(@__DIR__, "src", "inventories", "Julia.toml")
     ),
     "JuliaDocs" => (

diff --git a/docs/src/creating.md b/docs/src/creating.md
@@ -1,6 +1,6 @@
 # Creating Inventory Files
 
-In general, inventory files should be generated automatically by [Documenter](@extref Documenter :doc:`index`) or [Sphinx](@extref sphinx :doc:`index`). However, there are situations where producing and inventory file "by hand" make sense:
+In general, inventory files should be generated automatically by [Documenter](@extref Documenter :doc:`index`) or [Sphinx](@extref sphinx :doc:`index`). However, there are situations where producing an inventory file "by hand" make sense:
 
 * A project does not provide an inventory file. Maybe its documentation is entirely in its Github README file.
 
@@ -27,7 +27,7 @@ inventory = Inventory(
 nothing # hide
 ```
 
-Then, we can [`push!`](@extref Julia Base.push!) [`InventoryItems`](@ref InventoryItem) for all pages we want to include in the inventory:
+Then, we can [`push!`](@extref Julia Base.push!) new [`InventoryItems`](@ref InventoryItem) for all pages we want to include in the inventory:
 
 
 ```@example creating

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -56,6 +56,11 @@ to the relevant `Project.toml` file.
 Pages = [page for (name, page) in Main.PAGES[2:end]]
 ```
 
+## Changelog
+
+The `DocInventories` project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html). You can find a [`CHANGELOG` for versions after `v1.0`](https://github.com/JuliaDocs/DocInventories.jl/blob/master/CHANGELOG.md) online.
+
+
 ## Related Projects
 
 * [Documenter.jl](https://documenter.juliadocs.org/stable/) — The default documentation generator in the [Julia](https://julialang.org) ecosystem. As of version `1.3.0`, `Documenter` automatically generates and deploys a ([Sphinx-format](@ref "Sphinx Inventory Format")) `objects.inv` file that enables linking into a project's documentation.