Skip to content

Commit

Permalink
Merge pull request #14 from awesome-spectral-indices/fm/tests
Browse files Browse the repository at this point in the history 
Add Aqua for testing
  • Loading branch information
@MartinuzziFrancesco
MartinuzziFrancesco authored Dec 20, 2023
2 parents 61c8635 + 92dc68f commit 174cd67
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 5 deletions.
8 changes: 6 additions & 2 deletions Project.toml
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "SpectralIndices"
uuid = "df0093a1-273d-40bc-819a-796ec3476907"
authors = ["MartinuzziFrancesco <[email protected]>"]
version = "0.1.4"
version = "0.1.5"

[deps]
DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
Expand All @@ -13,15 +13,19 @@ YAXArrays = "c21b50f5-aa40-41ea-b809-c0f5e47bfa5c"

[compat]
DataFrames = "1"
Dates = "1"
DimensionalData = "0.25"
Downloads = "1"
JSON = "0.21"
YAXArrays = "0.5"
julia = "1.6"

[extras]
Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
JET = "c3a54625-cd67-489e-a8e7-0a5a0ff4e31b"
JuliaFormatter = "98e50ef6-434e-11e9-1051-2b60c6c9e899"
SafeTestsets = "1bc83da4-3b8d-516f-aca4-4fe02f6d838f"
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

[targets]
test = ["Test", "SafeTestsets"]
test = ["Test", "SafeTestsets", "Aqua", "JET", "JuliaFormatter"]
9 changes: 6 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
<img width="400px" src="docs/src/assets/logo.png"/>
</p>

| **Documentation** | **Build Status** | **Julia** |
|:-----------------:|:----------------:|:---------:|
| [![docs][docs-img]][docs-url] | [![CI][ci-img]][ci-url] [![codecov][cc-img]][cc-url] | [![Julia][julia-img]][julia-url] [![Code Style: Blue][style-img]][style-url] |
| **Documentation** | **Build Status** | **Julia** | **Testing** |
|:-----------------:|:----------------:|:---------:|:---------|
| [![docs][docs-img]][docs-url] | [![CI][ci-img]][ci-url] [![codecov][cc-img]][cc-url] | [![Julia][julia-img]][julia-url] [![Code Style: Blue][style-img]][style-url] | [![Aqua QA][aqua-img]][aqua-url] |

[docs-img]: https://img.shields.io/badge/docs-stable-blue.svg
[docs-url]: https://awesome-spectral-indices.github.io/SpectralIndices.jl/dev/
Expand All @@ -23,6 +23,9 @@
[style-img]: https://img.shields.io/badge/code%20style-blue-4495d1.svg
[style-url]: https://github.com/invenia/BlueStyle

[aqua-img]: https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg
[aqua-url]: https://github.com/JuliaTesting/Aqua.jl

## Overview

SpectralIndices.jl is a Julia package for working with spectral indices commonly used in remote sensing and earth observation applications. It provides a convenient way to compute various spectral indices using Julia's high-performance capabilities.
Expand Down
10 changes: 10 additions & 0 deletions test/runtests.jl
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
using SafeTestsets
using Test
using SpectralIndices
using JuliaFormatter: JuliaFormatter
#using JET: JET
using Aqua: Aqua

@testset "Quality Assurance" begin
Aqua.test_all(SpectralIndices; ambiguities=false, deps_compat=(check_extras=false,))
@test JuliaFormatter.format(SpectralIndices; verbose=false, overwrite=false)
#JET.test_package(SpectralIndices; target_defined_modules=true)
end

@safetestset "Axioms" begin
include("axioms.jl")
Expand Down

2 comments on commit 174cd67

@MartinuzziFrancesco
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()

Release notes:

Release Notes for SpectralIndices v0.1.5

We are pleased to announce the release of SpectralIndices v0.1.5. This update, while minor, includes an important enhancement to our testing process, ensuring even greater reliability and robustness of the SpectralIndices package.

What's New:

  • Improved Testing with Aqua: In this release, we've integrated Aqua into our testing suite. Aqua is a powerful tool for quality assurance in Julia packages, and its inclusion represents our ongoing commitment to software quality and stability. This update helps in catching more subtle bugs and issues, ensuring a higher standard of code quality.

How It Impacts You:

  • Users can expect a more robust and reliable package, as Aqua helps in ensuring that our code adheres to best practices and is free from common issues.
  • While this update does not introduce new features or changes to existing functionalities, it solidifies the foundation of SpectralIndices, paving the way for more feature-rich and stable releases in the future.

Moving Forward:

We will continue to refine and enhance SpectralIndices, and your feedback remains invaluable. Please continue to report any issues or suggestions for improvement.

Thank you for your continued support and trust in SpectralIndices.

— The SpectralIndices Development Team

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

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.1.5 -m "<description of version>" 174cd67b698388ed8d8e385e6b649597778940e4
git push origin v0.1.5

Please sign in to comment.