Skip to content

Commit

Permalink
Bump version to 1.3.4+dev
Browse files Browse the repository at this point in the history
  • Loading branch information
goerz committed Sep 19, 2024
2 parents 1cc8159 + 5efd7a0 commit 3f157e3
Show file tree
Hide file tree
Showing 8 changed files with 77 additions and 60 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/PkgEval.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@ jobs:
strategy:
fail-fast: false
steps:
- uses: julia-actions/setup-julia@v1
- uses: julia-actions/setup-julia@v2
with:
version: '1'
- uses: julia-actions/cache@v2
- uses: actions/checkout@v4
with:
repository: 'JuliaCI/PkgEval.jl'
Expand Down
17 changes: 9 additions & 8 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"
run: julia --project=test devrepl.jl
- name: "Run tests"
Expand All @@ -44,18 +44,19 @@ jobs:
- uses: julia-actions/julia-processcoverage@v1
- name: "Summarize coverage"
run: julia --project=test -L devrepl.jl -e 'show_coverage()'
- uses: codecov/codecov-action@v3
- uses: codecov/codecov-action@v4
with:
files: 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 --project=test {0}
run: |
Expand Down Expand Up @@ -85,7 +86,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 test environment"
Expand All @@ -95,7 +96,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-citations-docs
path: docs/build/
Expand All @@ -104,7 +105,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
12 changes: 11 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased][]


## [Version 1.3.4][1.3.4] - 2024-09-19

### Internal Changes

* Added an `article_link_doi_in_title` option to the internal `format_published_in` and `format_labeled_bibliography_reference` functions. This allows custom styles to change how links appear in bibliography entries for articles. By setting the option to `true`, the title of the article,instead of the "published in" information, will be used as the link text for a DOI . This makes the bibliography for articles more consistent with other types or entries, but is recommended only if no entries have both a DOI and a URL. [[#73][], [#74][]]


## [Version 1.3.3][1.3.3] - 2024-03-08

### Fixed
Expand Down Expand Up @@ -152,7 +159,8 @@ There were several bugs and limitations in version `1.2.x` for which some existi
* [DocumenterCitations](https://github.com/JuliaDocs/DocumenterCitations.jl) is now hosted under the [JuliaDocs](https://github.com/JuliaDocs) organization.


[Unreleased]: https://github.com/JuliaDocs/DocumenterCitations.jl/compare/v1.3.3...HEAD
[Unreleased]: https://github.com/JuliaDocs/DocumenterCitations.jl/compare/v1.3.4...HEAD
[1.3.4]: https://github.com/JuliaDocs/DocumenterCitations.jl/compare/v1.3.3...v1.3.4
[1.3.3]: https://github.com/JuliaDocs/DocumenterCitations.jl/compare/v1.3.2...v1.3.3
[1.3.2]: https://github.com/JuliaDocs/DocumenterCitations.jl/compare/v1.3.1...v1.3.2
[1.3.1]: https://github.com/JuliaDocs/DocumenterCitations.jl/compare/v1.3.0...v1.3.1
Expand All @@ -161,6 +169,8 @@ There were several bugs and limitations in version `1.2.x` for which some existi
[1.2.0]: https://github.com/JuliaDocs/DocumenterCitations.jl/compare/v1.1.0...v1.2.0
[1.1.0]: https://github.com/JuliaDocs/DocumenterCitations.jl/compare/v1.0.0...v1.1.0
[1.0.0]: https://github.com/JuliaDocs/DocumenterCitations.jl/compare/v0.2.12...v1.0.0
[#74]: https://github.com/JuliaDocs/DocumenterCitations.jl/pull/74
[#73]: https://github.com/JuliaDocs/DocumenterCitations.jl/issues/73
[#70]: https://github.com/JuliaDocs/DocumenterCitations.jl/pull/70
[#65]: https://github.com/JuliaDocs/DocumenterCitations.jl/pull/65
[#62]: https://github.com/JuliaDocs/DocumenterCitations.jl/pull/62
Expand Down
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "DocumenterCitations"
uuid = "daee34ce-89f3-4625-b898-19384cb65244"
authors = ["Michael Goerz <[email protected]>"]
version = "1.3.3+dev"
version = "1.3.4+dev"

[deps]
AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"
Expand Down
1 change: 1 addition & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ Clicking on the citations takes you to the bibliography ("[References](@ref)").
The following is a list of some projects that use `DocumenterCitations`:

* [Oceananigans](https://clima.github.io/OceananigansDocumentation/stable/)
* [OSCAR](https://docs.oscar-system.org/stable/)
* [QuantumPropagators](https://juliaquantumcontrol.github.io/QuantumPropagators.jl/)
* [QuantumControl](https://juliaquantumcontrol.github.io/QuantumControl.jl/)
* [TwoQubitWeylChamber](https://juliaquantumcontrol.github.io/TwoQubitWeylChamber.jl/)
Expand Down
4 changes: 2 additions & 2 deletions src/labeled_styles_utils.jl
Original file line number Diff line number Diff line change
Expand Up @@ -236,8 +236,8 @@ mdstr = format_labeled_bibliography_reference(
(Booktitle, Series) field. Strings enclosed in braces are protected
from the transformation.
* `article_link_doi_in_title`: If `false`, the URL is linked to the title for
Article entries, and the DOI is linked to the published-in. If `true`,
Article entries are handled as other entries, i.e. the first available URL
Article entries, and the DOI is linked to the published-in. If `true`,
Article entries are handled as other entries, i.e., the first available URL
(URL or, if no URL available, DOI) is linked to the title, while only in
the presence of both, the DOI is linked to the published-in.
"""
Expand Down
2 changes: 1 addition & 1 deletion src/styles/authoryear.jl
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ mdstr = format_authoryear_bibliography_reference(
from the transformation.
* `article_link_doi_in_title`: If `false`, the URL is linked to the title for
Article entries, and the DOI is linked to the published-in. If `true`,
Article entries are handled as other entries, i.e. the first available URL
Article entries are handled as other entries, i.e., the first available URL
(URL or, if no URL available, DOI) is linked to the title, while only in
the presence of both, the DOI is linked to the published-in.
"""
Expand Down
Loading

0 comments on commit 3f157e3

Please sign in to comment.