Skip to content

Commit

Permalink
Standardize yml; compat ImageGeoms v0.11; to v0.0.4 (#31)
Browse files Browse the repository at this point in the history 
* Standardize yml

* Add _typos
  • Loading branch information
@JeffFessler
JeffFessler authored May 17, 2024
1 parent 44fce6a commit c3b0667
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 8 deletions.
13 changes: 13 additions & 0 deletions .github/workflows/SpellCheck.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: Spell Check

on: [pull_request]

jobs:
typos-check:
name: Spell Check with Typos
runs-on: ubuntu-latest
steps:
- name: Checkout Actions Repository
uses: actions/checkout@v4
- name: Check spelling
uses: crate-ci/typos@master
6 changes: 3 additions & 3 deletions Project.toml
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "MRIFieldmaps"
uuid = "5af58b90-8a55-4daf-adb4-2008a66a38cf"
authors = ["Jeff Fessler <[email protected]> and others"]
version = "0.0.3"
version = "0.0.4"

[deps]
ImageGeoms = "9ee76f2b-840d-4475-b6d6-e485c9297852"
Expand All @@ -11,7 +11,7 @@ SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"

[compat]
ImageGeoms = "0.10"
ImageGeoms = "0.10, 0.11"
LimitedLDLFactorizations = "0.5"
StatsBase = "0.33, 0.34"
julia = "v1.9"
julia = "v1.10"
5 changes: 5 additions & 0 deletions _typos.toml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[default]
extend-ignore-identifiers-re = [
"nd",
"numer",
]
10 changes: 5 additions & 5 deletions docs/make.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ execute = isempty(ARGS) || ARGS[1] == "run"

org, reps = :MagneticResonanceImaging, :MRIFieldmaps
eval(:(using $reps))
using Documenter
using Literate
import Documenter
import Literate

# https://juliadocs.github.io/Documenter.jl/stable/man/syntax/#@example-block
ENV["GKSwstype"] = "100"
Expand All @@ -23,7 +23,7 @@ binder_root_url =


repo = eval(:($reps))
DocMeta.setdocmeta!(repo, :DocTestSetup, :(using $reps); recursive=true)
Documenter.DocMeta.setdocmeta!(repo, :DocTestSetup, :(using $reps); recursive=true)

# preprocessing
inc1 = "include(\"../../../inc/reproduce.jl\")"
Expand Down Expand Up @@ -77,7 +77,7 @@ format = Documenter.HTML(;
assets = ["assets/custom.css"],
)

makedocs(;
Documenter.makedocs(;
modules = [repo],
authors = "Jeff Fessler and contributors",
sitename = "$repo.jl",
Expand All @@ -90,7 +90,7 @@ makedocs(;
)

if isci
deploydocs(;
Documenter.deploydocs(;
repo = "github.com/$base",
devbranch = "main",
devurl = "dev",
Expand Down

2 comments on commit c3b0667

@JeffFessler
Copy link
Member Author

Choose a reason for hiding this comment

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

@JuliaRegistrator() register

@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/107111

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 v0.0.4 -m "<description of version>" c3b06674e76d1dc2f6d88940f9c75cb2c31a9f59
git push origin v0.0.4

Please sign in to comment.