Skip to content

Commit

Permalink
[nop] Update project template
Browse files Browse the repository at this point in the history
  • Loading branch information
ptaoussanis committed Oct 29, 2024
1 parent 2f57673 commit 872747e
Show file tree
Hide file tree
Showing 9 changed files with 66 additions and 44 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/graal-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,20 @@ jobs:

runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- uses: graalvm/setup-graalvm@v1
with:
version: 'latest'
java-version: ${{ matrix.java }}
components: 'native-image'
github-token: ${{ secrets.GITHUB_TOKEN }}

- uses: DeLaGuardo/setup-clojure@10.0
- uses: DeLaGuardo/setup-clojure@12.5
with:
lein: latest
bb: latest

- uses: actions/cache@v3
- uses: actions/cache@v4
with:
path: ~/.m2/repository
key: deps-${{ hashFiles('deps.edn') }}
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/main-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@ jobs:

runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v3
- uses: actions/setup-java@v3
- uses: actions/checkout@v4
- uses: actions/setup-java@v4
with:
distribution: 'corretto'
java-version: ${{ matrix.java }}

- uses: DeLaGuardo/setup-clojure@10.0
- uses: DeLaGuardo/setup-clojure@12.5
with:
lein: latest

- uses: actions/cache@v3
- uses: actions/cache@v4
id: cache-deps
with:
path: ~/.m2/repository
Expand Down
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
<a href="https://www.taoensso.com/clojure" title="More stuff by @ptaoussanis at www.taoensso.com"><img src="https://www.taoensso.com/open-source.png" alt="Taoensso open source" width="340"/></a>
[**Documentation**](#documentation) | [Latest releases](#latest-releases) | [Get support][GitHub issues]
[**API**][codox docs] | [**Wiki**][GitHub wiki] | [Latest releases](#latest-releases) | [Slack channel][]

# Tufte

### Simple performance monitoring for Clojure/Script applications
### Simple performance monitoring library for Clojure/Script

**Tufte** allows you to **easily monitor the ongoing performance** of your Clojure and ClojureScript applications in production and other environments.

It provides **sensible application-level metrics**, and gives them to you as **Clojure data** that can be easily analyzed programatically.
It provides **sensible application-level metrics**, and gives them to you as **Clojure data** that can be easily analyzed programatically.

Works great with [Telemere](https://www.taoensso.com/telemere), enabling unique **next-gen observability** of Clojure/Script applications.

<img width="600" src="../../raw/master/hero.png" alt="Carte Figurative"/>

> [Carte Figurative](https://en.wikipedia.org/wiki/Charles_Joseph_Minard#The_map_of_Napoleon's_Russian_campaign), one of [Edward Tufte](https://en.wikipedia.org/wiki/Edward_Tufte)'s favourite data visualizations.
## Latest release/s

- `2023-09-27` `2.6.3`: [changes](../../releases/tag/v2.6.3)
- `2023-09-27` `2.6.3`: [release info](../../releases/tag/v2.6.3)

[![Main tests][Main tests SVG]][Main tests URL]
[![Graal tests][Graal tests SVG]][Graal tests URL]
Expand All @@ -32,7 +34,7 @@ See [here][GitHub releases] for earlier releases.
- Arbitrary Clojure/Script **form-level** profiling
- Full support for **thread-local** and **multi-threaded** profiling

## 10-second example
## Quick example

```clojure
(require '[taoensso.tufte :as tufte :refer [defnp p profiled profile]])
Expand Down Expand Up @@ -64,31 +66,32 @@ See [here][GitHub releases] for earlier releases.

## Documentation

- [Full documentation][GitHub wiki] (**getting started** and more)
- Auto-generated API reference: [Codox][Codox docs], [clj-doc][clj-doc docs]
- [Wiki][GitHub wiki] (getting started, usage, etc.)
- API reference: [cljdoc][cljdoc docs], [Codox][Codox docs]

## Funding

You can [help support][sponsor] continued work on this project, thank you!! 🙏

## License

Copyright &copy; 2016-2023 [Peter Taoussanis][].
Copyright &copy; 2016-2024 [Peter Taoussanis][].
Licensed under [EPL 1.0](LICENSE.txt) (same as Clojure).

<!-- Common -->

[GitHub releases]: ../../releases
[GitHub issues]: ../../issues
[GitHub wiki]: ../../wiki
[Slack channel]: https://www.taoensso.com/tufte/slack

[Peter Taoussanis]: https://www.taoensso.com
[sponsor]: https://www.taoensso.com/sponsor

<!-- Project -->

[Codox docs]: https://taoensso.github.io/tufte/
[clj-doc docs]: https://cljdoc.org/d/com.taoensso/tufte/
[Codox docs]: https://taoensso.github.io/tufte/
[cljdoc docs]: https://cljdoc.org/d/com.taoensso/tufte/CURRENT/api/taoensso.tufte

[Clojars SVG]: https://img.shields.io/clojars/v/com.taoensso/tufte.svg
[Clojars URL]: https://clojars.org/com.taoensso/tufte
Expand Down
53 changes: 27 additions & 26 deletions project.clj
Original file line number Diff line number Diff line change
@@ -1,54 +1,55 @@
(defproject com.taoensso/tufte "2.6.3"
:author "Peter Taoussanis <https://www.taoensso.com>"
:description "Simple performance monitoring for Clojure/Script applications"
:description "Simple performance monitoring library for Clojure/Script"
:url "https://github.com/taoensso/tufte"

:license
{:name "Eclipse Public License - v 1.0"
:url "https://www.eclipse.org/legal/epl-v10.html"}

:test-paths ["test" #_"src"]

:dependencies
[[com.taoensso/encore "3.68.0"]]

:profiles
{;; :default [:base :system :user :provided :dev]
:provided {:dependencies [[org.clojure/clojurescript "1.11.121"]
[org.clojure/clojure "1.11.1"]]}
:c1.12 {:dependencies [[org.clojure/clojure "1.12.0-alpha9"]]}
:c1.11 {:dependencies [[org.clojure/clojure "1.11.1"]]}
:c1.10 {:dependencies [[org.clojure/clojure "1.10.1"]]}
:c1.9 {:dependencies [[org.clojure/clojure "1.9.0"]]}
:test
{:jvm-opts ["-Dtaoensso.elide-deprecated=true"]

:graal-tests
{:source-paths ["test"]
:main taoensso.graal-tests
:aot [taoensso.graal-tests]
:uberjar-name "graal-tests.jar"
:dependencies
[[org.clojure/clojure "1.11.1"]
[com.github.clj-easy/graal-build-time "1.0.5"]]}

:dev
{:jvm-opts ["-server" "-Dtaoensso.elide-deprecated=true"]
:global-vars
{*warn-on-reflection* true
*assert* true
*unchecked-math* false #_:warn-on-boxed}

:dependencies
[[org.clojure/test.check "1.1.1"]
[com.taoensso/timbre "6.3.1"]]}

:graal-tests
{:dependencies [[org.clojure/clojure "1.11.1"]
[com.github.clj-easy/graal-build-time "1.0.5"]]
:main taoensso.graal-tests
:aot [taoensso.graal-tests]
:uberjar-name "graal-tests.jar"}

:dev
[:c1.11 :test
{:jvm-opts ["-server"]
:plugins
[[lein-pprint "1.3.2"]
[lein-ancient "0.7.0"]
[lein-cljsbuild "1.1.8"]
[com.taoensso.forks/lein-codox "0.10.10"]]
[com.taoensso/timbre "6.3.1"]]

:codox
{:language #{:clojure :clojurescript}
:base-language :clojure}}]}
:plugins
[[lein-pprint "1.3.2"]
[lein-ancient "0.7.0"]
[lein-cljsbuild "1.1.8"]
[com.taoensso.forks/lein-codox "0.10.10"]]

:test-paths ["test" #_"src"]
:codox
{:language #{:clojure :clojurescript}
:base-language :clojure}}}

:cljsbuild
{:test-commands {"node" ["node" "target/test.js"]}
Expand All @@ -71,6 +72,6 @@
"build-once" ["do" ["clean"] ["cljsbuild" "once"]]
"deploy-lib" ["do" ["build-once"] ["deploy" "clojars"] ["install"]]

"test-clj" ["with-profile" "+c1.11:+c1.10:+c1.9" "test"]
"test-cljs" ["with-profile" "+test" "cljsbuild" "test"]
"test-clj" ["with-profile" "+c1.12:+c1.11:+c1.10:+c1.9" "test"]
"test-cljs" ["with-profile" "+c1.12" "cljsbuild" "test"]
"test-all" ["do" ["clean"] ["test-clj"] ["test-cljs"]]})
6 changes: 6 additions & 0 deletions test/taoensso/stats_tests.cljc
Original file line number Diff line number Diff line change
Expand Up @@ -150,4 +150,10 @@

;;;;

#?(:cljs
(defmethod test/report [:cljs.test/default :end-run-tests] [m]
(when-not (test/successful? m)
;; Trigger non-zero `lein test-cljs` exit code for CI
(throw (ex-info "ClojureScript tests failed" {})))))

#?(:cljs (test/run-tests))
6 changes: 6 additions & 0 deletions test/taoensso/tufte_tests.cljc
Original file line number Diff line number Diff line change
Expand Up @@ -626,4 +626,10 @@

;;;;

#?(:cljs
(defmethod test/report [:cljs.test/default :end-run-tests] [m]
(when-not (test/successful? m)
;; Trigger non-zero `lein test-cljs` exit code for CI
(throw (ex-info "ClojureScript tests failed" {})))))

#?(:cljs (test/run-tests))
1 change: 1 addition & 0 deletions wiki/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
README.md
2 changes: 1 addition & 1 deletion wiki/Home.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
See the menu to the right for content 👉
See the **menu to the right** for content 👉

# Contributions welcome

Expand Down
5 changes: 5 additions & 0 deletions wiki/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Attention!

This wiki is designed for viewing from [here](../../../wiki)!

Viewing from GitHub's file browser will result in **broken links**.

0 comments on commit 872747e

Please sign in to comment.