From 4c6d319e2c2ca26f41143dfdc30344eba26bc9da Mon Sep 17 00:00:00 2001 From: Stig Brautaset Date: Tue, 19 Mar 2024 20:47:54 +0000 Subject: [PATCH] Add a CI job to test that docs generation works --- .circleci/config.yml | 17 +++++++++++++++++ docs/circleci.analytics-clj.core.html | 4 ++-- docs/index.html | 2 +- 3 files changed, 20 insertions(+), 3 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 8fcb7b0..dab3a02 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -24,6 +24,22 @@ jobs: paths: - "~/.m2" + docs: + <<: *defaults + steps: + - checkout + + - restore_cache: + keys: + - v1-m2-{{ .Branch }}-{{ checksum "project.clj" }} + + - run: lein codox + + - save_cache: + key: v1-m2-{{ .Branch }}-{{ checksum "project.clj" }} + paths: + - "~/.m2" + test: <<: *defaults steps: @@ -61,6 +77,7 @@ workflows: build_and_test: jobs: - build + - docs - test: requires: - build diff --git a/docs/circleci.analytics-clj.core.html b/docs/circleci.analytics-clj.core.html index e11568e..46d5c8b 100644 --- a/docs/circleci.analytics-clj.core.html +++ b/docs/circleci.analytics-clj.core.html @@ -1,6 +1,6 @@ -circleci.analytics-clj.core documentation

Project

Namespaces

Public Vars

circleci.analytics-clj.core

alias
added in 0.4.0
(alias analytics previous-id user-id)(alias analytics previous-id user-id options)
`alias` is how you associate one identity with another.
+circleci.analytics-clj.core documentation
Project
Namespaces
Public Vars
circleci.analytics-clj.core
alias
added in 0.4.0
(alias analytics previous-id user-id)(alias analytics previous-id user-id options)
`alias` is how you associate one identity with another.
 This is an advanced method, but it is required to manage
 user identities successfully in some of our integrations.
enqueue
added in 0.4.0
(enqueue analytics message-builder)
Top-level `enqueue` function to allow for extensibility in the future.
 
flush
added in 0.4.0
(flush analytics)
Flush events in the message queue.
@@ -17,4 +17,4 @@
 extra information about the screen being viewed.
shutdown
added in 0.4.0
(shutdown analytics)
Stops this instance from processing further requests.
 
track
added in 0.4.0
(track analytics user-id event)(track analytics user-id event properties)(track analytics user-id event properties options)
`track` lets you record the actions your users perform.
 Every action triggers what we call an “event”, which can
-also have associated properties.

+also have associated properties.

\ No newline at end of file
diff --git a/docs/index.html b/docs/index.html
index 6375c9c..5da1aa6 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1,3 +1,3 @@
 
-Analytics-clj 0.8.2
Project
Namespaces
Analytics-clj 0.8.2
Released under the Eclipse Public License
Idiomatic Clojure wrapper for the Segment.io 2.x Java client.
Installation
To install, add the following dependency to your project or build file:
[circleci/analytics-clj "0.8.2"]
Namespaces
circleci.analytics-clj.core
Public variables and functions:

+Analytics-clj 0.8.2
Project
Namespaces
Analytics-clj 0.8.2
Released under the Eclipse Public License
Idiomatic Clojure wrapper for the Segment.io 2.x Java client.
Installation
To install, add the following dependency to your project or build file:
[circleci/analytics-clj "0.8.2"]
Namespaces
circleci.analytics-clj.core
Public variables and functions:

\ No newline at end of file