From 8e36999968e7ba65b8435432ca217e7443a95a98 Mon Sep 17 00:00:00 2001 From: Dylan Asmar Date: Mon, 15 Aug 2022 23:45:14 -0700 Subject: [PATCH 1/2] ci workflow update, readme update, files cleanup --- .github/workflows/CI.yml | 51 +++++++++++++++++++++++++++++++++++----- .gitignore | 3 +-- README.md | 6 ++--- docs/Project.toml | 2 ++ docs/make.jl | 3 +-- 5 files changed, 52 insertions(+), 13 deletions(-) create mode 100644 docs/Project.toml diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index af98974..9c9522d 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -1,16 +1,55 @@ name: CI - -on: [push, pull_request] - +on: + push: + branches: + - master + 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" + os: + - ubuntu-latest + - macOS-latest + - windows-latest + arch: + - x64 + # - aarch64 + steps: + - uses: actions/checkout@v2 + - 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 + permissions: write-all runs-on: ubuntu-latest - steps: - uses: actions/checkout@v2 - uses: julia-actions/setup-julia@v1 with: version: '1' - arch: x64 - uses: julia-actions/julia-buildpkg@v1 - - uses: julia-actions/julia-runtest@v1 + - uses: julia-actions/julia-docdeploy@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} \ No newline at end of file diff --git a/.gitignore b/.gitignore index 142048f..6c2ed8f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,6 @@ -*.jl.cov -*.jl.mem docs/build/ docs/site/ *.swp *Manifest.toml *ipynb_checkpoints/ +.vscode diff --git a/README.md b/README.md index 76382ec..70cd60b 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # MCTS -[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://juliapomdp.github.io/MCTS.jl/latest) -[![Build Status](https://travis-ci.org/JuliaPOMDP/MCTS.jl.svg?branch=master)](https://travis-ci.org/JuliaPOMDP/MCTS.jl) -[![Coverage Status](https://coveralls.io/repos/github/JuliaPOMDP/MCTS.jl/badge.svg?branch=master)](https://coveralls.io/github/JuliaPOMDP/MCTS.jl?branch=master) +[![CI](https://github.com/JuliaPOMDP/MCTS.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/JuliaPOMDP/MCTS.jl/actions/workflows/CI.yml) +[![codecov](https://codecov.io/gh/JuliaPOMDP/MCTS.jl/branch/master/graph/badge.svg?token=lwo3VqC7eQ)](https://codecov.io/gh/JuliaPOMDP/MCTS.jl) +[![Documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliapomdp.github.io/MCTS.jl/stable) [![MCTS Tree for Grid World, visualized](https://github.com/JuliaPOMDP/MCTS.jl/raw/master/img/tree.png)](https://nbviewer.jupyter.org/github/JuliaPOMDP/MCTS.jl/blob/master/notebooks/Test_Visualization.ipynb) diff --git a/docs/Project.toml b/docs/Project.toml new file mode 100644 index 0000000..9311ade --- /dev/null +++ b/docs/Project.toml @@ -0,0 +1,2 @@ +[deps] +Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" \ No newline at end of file diff --git a/docs/make.jl b/docs/make.jl index b0cf1c5..83be5b1 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -5,6 +5,5 @@ makedocs() deploydocs( deps = Deps.pip("mkdocs", "python-markdown-math"), repo = "github.com/JuliaPOMDP/MCTS.jl.git", - julia = "0.6", - osname = "linux" + versions = ["stable" => "v^", "v#.#"], ) From 81b2b9c9f58bea5dbc1cca7d3f1a4807792f66cb Mon Sep 17 00:00:00 2001 From: Dylan Asmar Date: Tue, 16 Aug 2022 00:03:55 -0700 Subject: [PATCH 2/2] doc build update --- docs/make.jl | 13 +++++++++++-- docs/mkdocs.yml | 26 -------------------------- 2 files changed, 11 insertions(+), 28 deletions(-) delete mode 100644 docs/mkdocs.yml diff --git a/docs/make.jl b/docs/make.jl index 83be5b1..2d2e899 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,9 +1,18 @@ using Documenter, MCTS -makedocs() +makedocs( + modules = [MCTS], + format = Documenter.HTML(), + sitename = "MCTS.jl", + pages = [ + "index.md", + "vanilla.md", + "dpw.md", + "belief_mcts.md", + ] +) deploydocs( - deps = Deps.pip("mkdocs", "python-markdown-math"), repo = "github.com/JuliaPOMDP/MCTS.jl.git", versions = ["stable" => "v^", "v#.#"], ) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml deleted file mode 100644 index 80fa227..0000000 --- a/docs/mkdocs.yml +++ /dev/null @@ -1,26 +0,0 @@ -site_name: MCTS.jl -repo_url: https://github.com/JuliaPOMDP/MCTS.jl -site_description: Monte Carlo Tree Search implemented in Julia -site_author: Zachary Sunberg - -theme: readthedocs - -extra_css: - - assets/Documenter.css - -extra_javascript: - - https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML - - assets/mathjaxhelper.js - -markdown_extensions: - - extra - - tables - - fenced_code - - mdx_math - -docs_dir: 'build' - -pages: - - Home: index.md - - Vanilla: vanilla.md - - DPW: dpw.md