Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make TimeZones.jl relocatable #479

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Make TimeZones.jl relocatable #479

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
56865ff
Set _COMPILED_DIR during __init__
lcontento Oct 29, 2024
05d4c9e
Add fallback for older versions of TZJData
lcontento Nov 4, 2024
ca1ba7b
Backwards compatibility with hardcoded artifact hashes
lcontento Nov 4, 2024
8879f7e
Merge branch 'master' into lc/relocatable
lcontento Nov 4, 2024
0402582
remove the docs manifest
lcontento Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ authors = ["Curtis Vogt <[email protected]>"]
version = "1.19.0"

[deps]
Artifacts = "56f22d72-fd6d-98f1-02f0-08ddc0907c33"
Copy link
Member

Choose a reason for hiding this comment

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

Need to update the docs/Manifest.toml

Copy link
Author

Choose a reason for hiding this comment

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

Do you really need a Manifest there? I will try to remove it just to see if it works.

Otherwise I am a bit unsure how to edit it since the entry for TimeZones is at a previous version, so if I added the Artifacts dependency there it would be weird. I am not very familiar with the process for building the documentation in Julia, so I am not sure where exactly the error occurs.

Copy link
Author

Choose a reason for hiding this comment

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

It works without a Manifest there. It seems reasonable to me but again I am not familiar with Documenter.

Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
Downloads = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
InlineStrings = "842dd82b-1e85-43dc-bf29-5d0ee9dffc48"
Expand All @@ -22,6 +23,7 @@ RecipesBase = "3cdcf5f2-1ef4-517c-9805-6587b60abb01"
TimeZonesRecipesBaseExt = "RecipesBase"

[compat]
Artifacts = "1"
Aqua = "0.8"
Dates = "1"
Downloads = "1"
Expand Down
23 changes: 22 additions & 1 deletion src/TimeZones.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
module TimeZones

using Artifacts
using Dates
using Printf
using Scratch: @get_scratch!
Expand Down Expand Up @@ -33,13 +34,33 @@

_scratch_dir() = @get_scratch!("build")

const _COMPILED_DIR = Ref{String}(TZJData.ARTIFACT_DIR)
const _COMPILED_DIR = Ref{String}()

# TimeZone types used to disambiguate the context of a DateTime
# abstract type UTC <: TimeZone end # Already defined in the Dates stdlib
abstract type Local <: TimeZone end

function __init__()
# Must be set at runtime to ensure relocatability
_COMPILED_DIR[] = if isdefined(TZJData, :artifact_dir)
# Recent versions of TZJData are relocatable
TZJData.artifact_dir()

Check warning on line 47 in src/TimeZones.jl

View check run for this annotation

Codecov / codecov/patch

src/TimeZones.jl#L47 

Added line #L47 was not covered by tests
else
# Backwards compatibility with TZJData v1.3.0 and below
hash = if TZJData.TZDATA_VERSION == "2024b"
Base.SHA1("7fdea2a12522469ca39925546d1fd93c10748180")
elseif TZJData.TZDATA_VERSION == "2024a"
Base.SHA1("520ce3f83be7fbb002cca87993a1b1f71fe10912")
elseif TZJData.TZDATA_VERSION == "2023d"
Base.SHA1("b071cffdb310f5d3ca640c09cfa3dc3f23d450ad")
elseif TZJData.TZDATA_VERSION == "2023c"
Base.SHA1("52e48e96c4df04eeebc6ece0d9f1c3b545f0544c")

Check warning on line 57 in src/TimeZones.jl

View check run for this annotation

Codecov / codecov/patch

src/TimeZones.jl#L52-L57 

Added lines #L52 - L57 were not covered by tests
else
error("TZJData.jl with TZDATA_VERSION = $(TZJData.TZDATA_VERSION) is supposed to be relocatable!")
end
Artifacts.artifact_path(hash)
end

# Dates extension needs to happen everytime the module is loaded (issue #24)
init_dates_extension()

Expand Down
Loading