Update CI (#6)

devmotion · web-flow · commit 249310997345 · 2021-10-19T01:32:23.000+02:00
* Update CompatHelper.yml

* Update and rename ci.yml to CI.yml

* Update badges

* Create Format.yml

* Update README.md

* Create .JuliaFormatter.toml

* Fix format
diff --git a/.JuliaFormatter.toml b/.JuliaFormatter.toml
@@ -0,0 +1 @@
+style="blue"
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -3,9 +3,15 @@ name: CI
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
 
+concurrency:
+  # Skip intermediate builds: always.
+  # Cancel intermediate builds: only if it is a pull request build.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+
 jobs:
   test:
     name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }}
@@ -19,19 +25,18 @@ jobs:
           - 'nightly'
         os:
           - ubuntu-latest
-          - macOS-latest
-          - windows-latest
         arch:
-          - x86
           - x64
         include:
           - version: '1'
             os: ubuntu-latest
-            arch: x64
-            coverage: true
-        exclude:
-          - os: macOS-latest
             arch: x86
+          - version: '1'
+            os: macOS-latest
+            arch: x64
+          - version: '1'
+            os: windows-latest
+            arch: x64
     steps:
       - uses: actions/checkout@v2
       - uses: julia-actions/setup-julia@v1
@@ -50,14 +55,16 @@ jobs:
             ${{ runner.os }}-
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
+        with:
+          coverage: ${{ matrix.version == '1' && matrix.os == 'ubuntu-latest' && matrix.arch == 'x64' }}
       - uses: julia-actions/julia-processcoverage@v1
-        if: matrix.coverage
+        if: matrix.version == '1' && matrix.os == 'ubuntu-latest' && matrix.arch == 'x64'
       - uses: codecov/codecov-action@v1
-        if: matrix.coverage
+        if: matrix.version == '1' && matrix.os == 'ubuntu-latest' && matrix.arch == 'x64'
         with:
           file: lcov.info
       - uses: coverallsapp/github-action@master
-        if: matrix.coverage
+        if: matrix.version == '1' && matrix.os == 'ubuntu-latest' && matrix.arch == 'x64'
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           path-to-lcov: lcov.info
diff --git a/.github/workflows/CompatHelper.yml b/.github/workflows/CompatHelper.yml
@@ -1,16 +1,33 @@
 name: CompatHelper
+
 on:
   schedule:
-    - cron: '00 00 * * *'
+    - cron: 0 0 * * *
   workflow_dispatch:
+
 jobs:
   CompatHelper:
     runs-on: ubuntu-latest
     steps:
-      - name: Pkg.add("CompatHelper")
-        run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
-      - name: CompatHelper.main()
+      - name: "Add the General registry via Git"
+        run: |
+          import Pkg
+          ENV["JULIA_PKG_SERVER"] = ""
+          Pkg.Registry.add("General")
+        shell: julia --color=yes {0}
+      - name: "Install CompatHelper"
+        run: |
+          import Pkg
+          name = "CompatHelper"
+          uuid = "aa819f21-2bde-4658-8897-bab36330d9b7"
+          version = "3"
+          Pkg.add(; name, uuid, version)
+        shell: julia --color=yes {0}
+      - name: "Run CompatHelper"
+        run: |
+          import CompatHelper
+          CompatHelper.main()
+        shell: julia --color=yes {0}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           COMPATHELPER_PRIV: ${{ secrets.COMPATHELPER_PRIV }}
-        run: julia -e 'using CompatHelper; CompatHelper.main()'
diff --git a/.github/workflows/Format.yml b/.github/workflows/Format.yml
@@ -0,0 +1,31 @@
+name: Format
+
+on:
+  pull_request:
+
+concurrency:
+  # Skip intermediate builds: always.
+  # Cancel intermediate builds: only if it is a pull request build.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+
+jobs:
+  format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: 1
+      - name: Format code
+        run: |
+          using Pkg
+          Pkg.add(; name="JuliaFormatter", uuid="98e50ef6-434e-11e9-1051-2b60c6c9e899")
+          using JuliaFormatter
+          format("."; verbose=true)
+        shell: julia --color=yes {0}
+      - uses: reviewdog/action-suggester@v1
+        if: github.event_name == 'pull_request'
+        with:
+          tool_name: JuliaFormatter
+          fail_on_error: true
diff --git a/README.md b/README.md
@@ -1,8 +1,9 @@
 # PalmerPenguins.jl <a href='https://allisonhorst.github.io/palmerpenguins'><img src='https://allisonhorst.github.io/palmerpenguins/reference/figures/logo.png' align="right" height="138.5" /></a>
 
-[![Build Status](https://github.com/devmotion/PalmerPenguins.jl/workflows/CI/badge.svg)](https://github.com/devmotion/PalmerPenguins.jl/actions?query=workflow%3ACI+branch%3Amaster)
-[![Coverage](https://codecov.io/gh/devmotion/PalmerPenguins.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/devmotion/PalmerPenguins.jl)
-[![Coverage](https://coveralls.io/repos/github/devmotion/PalmerPenguins.jl/badge.svg?branch=master)](https://coveralls.io/github/devmotion/PalmerPenguins.jl?branch=master)
+[![Build Status](https://github.com/devmotion/PalmerPenguins.jl/workflows/CI/badge.svg?branch=main)](https://github.com/devmotion/PalmerPenguins.jl/actions?query=workflow%3ACI+branch%3Amain)
+[![Coverage](https://codecov.io/gh/devmotion/PalmerPenguins.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/devmotion/PalmerPenguins.jl)
+[![Coverage](https://coveralls.io/repos/github/devmotion/PalmerPenguins.jl/badge.svg?branch=main)](https://coveralls.io/github/devmotion/PalmerPenguins.jl?branch=main)
+[![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
 
 Load the [Palmer penguins dataset](https://allisonhorst.github.io/palmerpenguins/), an
 alternative to the Iris dataset, in Julia.
@@ -59,7 +60,7 @@ julia> tableraw = PalmerPenguins.load(; raw = true)
 ```
 If `raw = false` (the default), then the simplified version is returned.
 
-## Bibliography
+## References
 
 Gorman KB, Williams TD, Fraser WR (2014) Ecological Sexual Dimorphism and Environmental
 Variability within a Community of Antarctic Penguins (Genus Pygoscelis). PLoS ONE 9(3):
diff --git a/src/PalmerPenguins.jl b/src/PalmerPenguins.jl
@@ -1,40 +1,39 @@
 module PalmerPenguins
 
-import CSV
-import DataDeps
+using CSV: CSV
+using DataDeps: DataDeps
 
 const DEPNAME = "PalmerPenguins"
 const LINK = "https://cdn.jsdelivr.net/gh/allisonhorst/palmerpenguins@433439c8b013eff3d36c847bb7a27fa0d7e353d8/inst/extdata/"
 const DATA = ["penguins.csv", "penguins_raw.csv"]
-const INFO =
-"""
-Dataset: The Palmer penguins dataset
-Authors: Allison Horst, Alison Hill, Kristen Gorman
-Website: https://allisonhorst.github.io/palmerpenguins/index.html
+const INFO = """
+             Dataset: The Palmer penguins dataset
+             Authors: Allison Horst, Alison Hill, Kristen Gorman
+             Website: https://allisonhorst.github.io/palmerpenguins/index.html
 
-The Palmer penguins dataset is a dataset for data exploration & visualization, as an
-alternative to the Iris dataset.
+             The Palmer penguins dataset is a dataset for data exploration & visualization, as an
+             alternative to the Iris dataset.
 
-The dataset contains data for 344 penguins. There are 3 different species of penguins in
-this dataset, collected from 3 islands in the Palmer Archipelago, Antarctica.
+             The dataset contains data for 344 penguins. There are 3 different species of penguins in
+             this dataset, collected from 3 islands in the Palmer Archipelago, Antarctica.
 
-Data were collected and made available by
-[Dr. Kristen Gorman](https://www.uaf.edu/cfos/people/faculty/detail/kristen-gorman.php)
-and the [Palmer Station, Antarctica LTER](https://pal.lternet.edu/), a member of the
-[Long Term Ecological Research Network](https://lternet.edu/).
+             Data were collected and made available by
+             [Dr. Kristen Gorman](https://www.uaf.edu/cfos/people/faculty/detail/kristen-gorman.php)
+             and the [Palmer Station, Antarctica LTER](https://pal.lternet.edu/), a member of the
+             [Long Term Ecological Research Network](https://lternet.edu/).
 
-Data are available by
-[CC-0](https://creativecommons.org/share-your-work/public-domain/cc0/) license in
-accordance with the [Palmer Station LTER Data Policy](http://pal.lternet.edu/data/policies)
-and the
-[LTER Data Access Policy for Type I data](https://lternet.edu/data-access-policy/).
+             Data are available by
+             [CC-0](https://creativecommons.org/share-your-work/public-domain/cc0/) license in
+             accordance with the [Palmer Station LTER Data Policy](http://pal.lternet.edu/data/policies)
+             and the
+             [LTER Data Access Policy for Type I data](https://lternet.edu/data-access-policy/).
 
-Please include this citation if you plan to use this database:
-[Gorman et al., 2014]
-    Gorman KB, Williams TD, Fraser WR (2014) Ecological Sexual Dimorphism and Environmental
-    Variability within a Community of Antarctic Penguins (Genus Pygoscelis). PLoS ONE 9(3):
-    e90081. https://doi.org/10.1371/journal.pone.0090081
-"""
+             Please include this citation if you plan to use this database:
+             [Gorman et al., 2014]
+                 Gorman KB, Williams TD, Fraser WR (2014) Ecological Sexual Dimorphism and Environmental
+                 Variability within a Community of Antarctic Penguins (Genus Pygoscelis). PLoS ONE 9(3):
+                 e90081. https://doi.org/10.1371/journal.pone.0090081
+             """
 
 """
     load([; raw = false])
@@ -51,21 +50,26 @@ the data is loaded.
     Variability within a Community of Antarctic Penguins (Genus Pygoscelis). PLoS ONE 9(3):
     e90081. https://doi.org/10.1371/journal.pone.0090081
 """
-function load(; raw::Bool = false)
+function load(; raw::Bool=false)
     file = DataDeps.@datadep_str DEPNAME * "/" * DATA[1 + Int(raw)]
     return CSV.File(
         file;
-        missingstring="NA", truestrings=["Yes"], falsestrings=["No"], dateformat="y-m-d",
+        missingstring="NA",
+        truestrings=["Yes"],
+        falsestrings=["No"],
+        dateformat="y-m-d",
     )
 end
 
 function __init__()
-    DataDeps.register(DataDeps.DataDep(
-        DEPNAME,
-        INFO,
-        LINK .* DATA,
-        "839b058be09b164f7dfa0d030a959cb3c5426dea281e8a34d34c557e398bd01f",
-    ))
+    return DataDeps.register(
+        DataDeps.DataDep(
+            DEPNAME,
+            INFO,
+            LINK .* DATA,
+            "839b058be09b164f7dfa0d030a959cb3c5426dea281e8a34d34c557e398bd01f",
+        ),
+    )
 end
 
 end
diff --git a/test/runtests.jl b/test/runtests.jl
@@ -30,13 +30,7 @@ ENV["DATADEPS_ALWAYS_ACCEPT"] = true
         Union{Missing,String},
     ]
     firstrow_simplified = [
-        "Adelie",
-        "Torgersen",
-        39.1,
-        18.7,
-        Int64(181),
-        Int64(3750),
-        "male"
+        "Adelie", "Torgersen", 39.1, 18.7, Int64(181), Int64(3750), "male"
     ]
 
     colnames_raw = [
@@ -99,7 +93,7 @@ ENV["DATADEPS_ALWAYS_ACCEPT"] = true
     @testset "load" begin
         @testset "simplified" begin
             table = PalmerPenguins.load()
-            table2 = PalmerPenguins.load(; raw = false)
+            table2 = PalmerPenguins.load(; raw=false)
             for i in 1:length(table)
                 @test all(table[i] .=== table2[i])
             end
@@ -120,7 +114,7 @@ ENV["DATADEPS_ALWAYS_ACCEPT"] = true
         end
 
         @testset "raw" begin
-            table = PalmerPenguins.load(; raw = true)
+            table = PalmerPenguins.load(; raw=true)
 
             # Check some properties
             @test table isa CSV.File
@@ -141,7 +135,7 @@ ENV["DATADEPS_ALWAYS_ACCEPT"] = true
     @testset "DataFrames" begin
         @testset "simplified" begin
             df = DataFrame(PalmerPenguins.load())
-            df2 = DataFrame(PalmerPenguins.load(; raw = false))
+            df2 = DataFrame(PalmerPenguins.load(; raw=false))
             for i in 1:size(df, 2)
                 @test all(df[!, i] .=== df2[!, i])
             end
@@ -162,7 +156,7 @@ ENV["DATADEPS_ALWAYS_ACCEPT"] = true
         end
 
         @testset "raw" begin
-            df = DataFrame(PalmerPenguins.load(; raw = true))
+            df = DataFrame(PalmerPenguins.load(; raw=true))
 
             # Check some properties
             @test df isa DataFrame
