From 75f4a01562338b8f749c12a2b46d9291f145f6b1 Mon Sep 17 00:00:00 2001 From: Michael Goerz Date: Fri, 7 Jun 2024 06:24:56 -0400 Subject: [PATCH] Release 1.0.0 This stabilizes the API, but is otherwise equivalent to the previous 0.3.3 release. --- .github/workflows/CI.yml | 28 +++++++++++++++------------- .github/workflows/ClearPreview.yml | 4 ++-- CHANGELOG.md | 5 +++++ Project.toml | 2 +- README.md | 4 ++-- 5 files changed, 25 insertions(+), 18 deletions(-) diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index ff06e23..c6732a5 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -31,10 +31,10 @@ jobs: version: '1' 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: | @@ -51,18 +51,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 }} testolder: name: Test with Documenter 1.2 runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: julia-actions/setup-julia@v1 + - uses: julia-actions/setup-julia@v2 with: version: 1.9 - - uses: julia-actions/cache@v1 + - uses: julia-actions/cache@v2 - name: "Instantiate test environment" shell: julia --color=yes --project=test {0} run: | @@ -79,18 +80,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: | @@ -121,7 +123,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" @@ -138,7 +140,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: documenter-interlinks-docs path: docs/build/ @@ -147,7 +149,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/.github/workflows/ClearPreview.yml b/.github/workflows/ClearPreview.yml index 115d997..94b9f70 100644 --- a/.github/workflows/ClearPreview.yml +++ b/.github/workflows/ClearPreview.yml @@ -9,7 +9,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout gh-pages branch - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: ref: gh-pages - name: Delete preview and history + push changes @@ -23,4 +23,4 @@ jobs: git push --force origin gh-pages-new:gh-pages fi env: - PRNUM: ${{ github.event.number }} \ No newline at end of file + PRNUM: ${{ github.event.number }} diff --git a/CHANGELOG.md b/CHANGELOG.md index 555ff1a..12b270b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,3 +2,8 @@ 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-07 + +* Initial stable release. This is functionally identical to the `v0.3.3` release. diff --git a/Project.toml b/Project.toml index 289c494..262d13a 100644 --- a/Project.toml +++ b/Project.toml @@ -1,7 +1,7 @@ name = "DocumenterInterLinks" uuid = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656" authors = ["Michael Goerz "] -version = "1.0.0-dev" +version = "1.0.0" [deps] CodecZlib = "944b1d66-785c-5afd-91f1-9de20f533193" diff --git a/README.md b/README.md index 9dc6cd5..523d7c0 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ Instead of [Documenter's `@ref`](https://documenter.juliadocs.org/stable/man/syn * See the section about Documenter's [Writers](@extref Documenter). ``` -See the [documentation](https://juliadocs.org/DocumenterInterLinks.jl/dev/#Using-External-References) and [recommended syntax](https://juliadocs.org/DocumenterInterLinks.jl/dev/syntax/#Recommended-Syntax) for details. +See the [documentation](https://juliadocs.org/DocumenterInterLinks.jl/stable/#Using-External-References) and [recommended syntax](https://juliadocs.org/DocumenterInterLinks.jl/stable/syntax/#Recommended-Syntax) for details. ## Inventories @@ -70,7 +70,7 @@ For some projects that do not (or not yet) provide an inventory, manually genera ## Documentation -The [full documentation of this project is available online](https://juliadocs.org/DocumenterInterLinks.jl/dev/). +The [full documentation of this project is available online](https://juliadocs.org/DocumenterInterLinks.jl/stable/). ## Related Projects