Skip to content

Commit

Permalink
Release 1.0.0
Browse files Browse the repository at this point in the history
This stabilizes the API, but is otherwise equivalent to the previous
0.3.3 release.
  • Loading branch information
goerz committed Jun 7, 2024
1 parent cf27ebe commit 75f4a01
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 18 deletions.
28 changes: 15 additions & 13 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand All @@ -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: |
Expand All @@ -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: |
Expand Down Expand Up @@ -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"
Expand All @@ -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/
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/ClearPreview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -23,4 +23,4 @@ jobs:
git push --force origin gh-pages-new:gh-pages
fi
env:
PRNUM: ${{ github.event.number }}
PRNUM: ${{ github.event.number }}
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "DocumenterInterLinks"
uuid = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
authors = ["Michael Goerz <[email protected]>"]
version = "1.0.0-dev"
version = "1.0.0"

[deps]
CodecZlib = "944b1d66-785c-5afd-91f1-9de20f533193"
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down

2 comments on commit 75f4a01

@goerz
Copy link
Member Author

@goerz goerz commented on 75f4a01 Jun 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/108447

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v1.0.0 -m "<description of version>" 75f4a01562338b8f749c12a2b46d9291f145f6b1
git push origin v1.0.0

Please sign in to comment.