diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 46cf4655..a7ee8e63 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -43,34 +43,3 @@ jobs: files: lcov.info token: ${{ secrets.CODECOV_TOKEN }} fail_ci_if_error: false - docs: - name: Documentation - runs-on: ubuntu-latest - permissions: - actions: write # needed to allow julia-actions/cache to proactively delete old caches that it has created - contents: write - statuses: write - steps: - - uses: actions/checkout@v4 - - uses: julia-actions/setup-julia@v2 - with: - version: '1' - - uses: julia-actions/cache@v2 - - name: Configure doc environment - shell: julia --project=docs --color=yes {0} - run: | - 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 }} - DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} - # - name: Run doctests - # shell: julia --project=docs --color=yes {0} - # run: | - # using Documenter: DocMeta, doctest - # using IESopt - # DocMeta.setdocmeta!(IESopt, :DocTestSetup, :(using IESopt); recursive=true) - # doctest(IESopt) diff --git a/.github/workflows/Documentation.yml b/.github/workflows/Documentation.yml new file mode 100644 index 00000000..ce966b68 --- /dev/null +++ b/.github/workflows/Documentation.yml @@ -0,0 +1,32 @@ +name: Documentation +on: + push: + branches: [main] + tags: '*' + pull_request: + types: [opened, synchronize, reopened] + workflow_dispatch: +jobs: + build: + runs-on: ubuntu-latest + permissions: + actions: write # needed to allow julia-actions/cache to proactively delete old caches that it has created + contents: write + statuses: write + steps: + - uses: actions/checkout@v4 + - uses: julia-actions/setup-julia@latest + with: + version: '1' + - uses: julia-actions/cache@v2 + - name: Configure doc environment + shell: julia --project=docs --color=yes {0} + run: | + 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 }} + DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} diff --git a/.github/workflows/DocPreviewCleanup.yml b/.github/workflows/DocumentationCleanup.yml similarity index 97% rename from .github/workflows/DocPreviewCleanup.yml rename to .github/workflows/DocumentationCleanup.yml index 2d3c291f..0794be7a 100644 --- a/.github/workflows/DocPreviewCleanup.yml +++ b/.github/workflows/DocumentationCleanup.yml @@ -1,7 +1,7 @@ # See: https://documenter.juliadocs.org/stable/man/hosting/#Cleaning-up-gh-pages # for more information on why and how to use this workflow. -name: DocPreviewCleanup +name: DocumenationCleanup on: pull_request: diff --git a/README.md b/README.md index f93a581d..113ec9bc 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,13 @@ # Integrated Energy System Optimization (IESopt.jl) +[![License](https://img.shields.io/github/license/ait-energy/IESopt.jl)](LICENSE) [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://ait-energy.github.io/IESopt.jl/stable/) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://ait-energy.github.io/IESopt.jl/dev/) + [![Build Status](https://github.com/ait-energy/IESopt.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/ait-energy/IESopt.jl/actions/workflows/CI.yml?query=branch%3Amain) [![Coverage](https://codecov.io/gh/ait-energy/IESopt.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ait-energy/IESopt.jl) [![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl) -[![Code Style](https://img.shields.io/badge/code_style-custom-blue?style=flat&logo=julia&logoColor=white)](.JuliaFormatter.toml) -[![Readme Style](https://img.shields.io/badge/readme_style-standard-lime?style=flat&logo=julia&logoColor=white)](https://github.com/RichardLitt/standard-readme) -[![License](https://img.shields.io/github/license/ait-energy/IESopt.jl)](LICENSE) - **IESopt** (_Integrated Energy System Optimization_) is a modeling and optimization framework for integrated energy systems. @@ -47,6 +45,9 @@ TODO: Document the API of the package. ## Contributing +[![Code Style](https://img.shields.io/badge/code_style-custom-blue?style=flat&logo=julia&logoColor=white)](.JuliaFormatter.toml) +[![Readme Style](https://img.shields.io/badge/readme_style-standard-lime?style=flat&logo=julia&logoColor=white)](https://github.com/RichardLitt/standard-readme) + PRs accepted. ## License