-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
34 changed files
with
734 additions
and
387 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| name: CI | ||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| tags: ['*'] | ||
| 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 }} - ${{ github.event_name }} | ||
| runs-on: ${{ matrix.os }} | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| version: | ||
| - '1.6' | ||
| - '1.7' | ||
| - '1.8' | ||
| - '1.9' | ||
| os: | ||
| - ubuntu-latest | ||
| - macOS-latest | ||
| arch: | ||
| - x64 | ||
| - x86 | ||
| exclude: | ||
| - os: macOS-latest | ||
| arch: x86 | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: julia-actions/setup-julia@v1 | ||
| with: | ||
| version: ${{ matrix.version }} | ||
| arch: ${{ matrix.arch }} | ||
| - uses: julia-actions/cache@v1 | ||
| - uses: julia-actions/julia-buildpkg@v1 | ||
| - uses: julia-actions/julia-runtest@v1 | ||
| - uses: julia-actions/julia-processcoverage@v1 | ||
| - uses: codecov/codecov-action@v3 | ||
| with: | ||
| files: lcov.info | ||
| docs: | ||
| name: Documentation | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write | ||
| statuses: write | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: julia-actions/setup-julia@v1 | ||
| with: | ||
| version: '1' | ||
| - name: Configure doc environment | ||
| run: | | ||
| julia --project=docs/ -e ' | ||
| using Pkg | ||
| Pkg.develop(PackageSpec(path=pwd())) | ||
| Pkg.instantiate()' | ||
| - uses: julia-actions/julia-buildpkg@v1 | ||
| - uses: julia-actions/julia-docdeploy@v1 | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| - run: | | ||
| julia --project=docs -e ' | ||
| using Documenter: DocMeta, doctest | ||
| using PrefectInterfaces | ||
| DocMeta.setdocmeta!(PrefectInterfaces, :DocTestSetup, :(using PrefectInterfaces); recursive=true) | ||
| doctest(PrefectInterfaces)' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| name: CompatHelper | ||
| on: | ||
| schedule: | ||
| - 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() | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }} | ||
| run: julia -e 'using CompatHelper; CompatHelper.main()' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| name: TagBot | ||
| on: | ||
| issue_comment: | ||
| types: | ||
| - created | ||
| workflow_dispatch: | ||
| inputs: | ||
| lookback: | ||
| default: 3 | ||
| permissions: | ||
| actions: read | ||
| checks: read | ||
| contents: write | ||
| deployments: read | ||
| issues: read | ||
| discussions: read | ||
| packages: read | ||
| pages: read | ||
| pull-requests: read | ||
| repository-projects: read | ||
| security-events: read | ||
| statuses: read | ||
| jobs: | ||
| TagBot: | ||
| if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot' | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: JuliaRegistries/TagBot@v1 | ||
| with: | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| ssh: ${{ secrets.DOCUMENTER_KEY }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| name: Register Package | ||
| on: | ||
| workflow_dispatch: | ||
| inputs: | ||
| version: | ||
| description: Version to register or component to bump | ||
| required: true | ||
| jobs: | ||
| register: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write | ||
| steps: | ||
| - uses: julia-actions/RegisterAction@latest | ||
| with: | ||
| token: ${{ secrets.GITHUB_TOKEN }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2023 mahiki | ||
| Copyright (c) 2023 mahiki <[email protected]> and contributors | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| [deps] | ||
| Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" | ||
| PrefectInterfaces = "25d49962-0f22-42a0-bb44-b427e1ded1d4" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| [deps] | ||
| Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| using PrefectInterfaces | ||
| using Documenter | ||
|
|
||
| push!(LOAD_PATH,"../src/") | ||
|
|
||
| DocMeta.setdocmeta!(PrefectInterfaces, :DocTestSetup, :(using PrefectInterfaces); recursive=true) | ||
|
|
||
| makedocs(; | ||
| modules=[PrefectInterfaces], | ||
| authors="mahiki <[email protected]>", | ||
| repo="https://github.com/mahiki/PrefectInterfaces.jl/blob/{commit}{path}#{line}", | ||
| sitename="PrefectInterfaces.jl", | ||
| format=Documenter.HTML(; | ||
| prettyurls=get(ENV, "CI", "false") == "true", | ||
| canonical="https://mahiki.github.io/PrefectInterfaces.jl", | ||
| edit_link="main", | ||
| assets=String[], | ||
| ), | ||
| pages=[ | ||
| "Introduction" => "index.md" | ||
| , "Demonstration" => "julia-demo.md" | ||
| , "Detailed Explanation" => "usage-and-explanation.md" | ||
| , "Prefect" => [ | ||
| "Prefect Install" => "prefect/install-local-prefect-environment.md" | ||
| , "Manual Install" => "prefect/setup-without-justfile.md" | ||
| ] | ||
| , "API" => [ | ||
| "Exported Names" => "lib/autodoc.md" | ||
| ] | ||
| , "Developers" => "developers.md" | ||
| ] | ||
|
|
||
| ) | ||
|
|
||
| deploydocs(; | ||
| repo="github.com/mahiki/PrefectInterfaces.jl", | ||
| devbranch="main", | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| # Developers | ||
| Develop and test with | ||
|
|
||
| ```bash | ||
| # launch the local prefect server if its not available | ||
| cd ./prefect | ||
| just launch | ||
|
|
||
| cd ./PrefectInterfaces | ||
| julia --project=. --startup-file=no --eval 'import Pkg; Pkg.test()' | ||
| # SERVER HEALTH CHECK # | ||
| # =================== # | ||
| Active Prefect Environment: main | ||
| ┌ Info: Prefect Server must be running, i.e. `prefect server start` | ||
| │ Calling http://127.0.0.1:4300/api/health | ||
| └ Server reponse status: 200 OK | ||
|
|
||
| Test Summary: | Pass Total Time | ||
| All tests | 94 94 2.7s | ||
| Config | 9 9 0.4s | ||
| Block types, function tests | 58 58 1.8s | ||
| Dataset function | 27 27 0.5s | ||
|
|
||
| Testing PrefectInterfaces tests passed | ||
| ``` | ||
|
|
||
| Alternately, using the `justfile` | ||
| ```julia | ||
| cd .../PrefectInterfaces | ||
|
|
||
| just test | ||
| ``` | ||
|
|
||
| Or, from the REPL: | ||
|
|
||
| `julia --project=.` | ||
| ```julia | ||
| pkg> activate . | ||
| pkg> test | ||
| ``` |
Oops, something went wrong.