https://github.com/xcoo/metabill

A minimal library to read build timestamp from JAR/WAR manifests.
https://github.com/xcoo/metabill

clojure jar

Last synced: 3 months ago
JSON representation

A minimal library to read build timestamp from JAR/WAR manifests.

• Host: GitHub
• URL: https://github.com/xcoo/metabill
• Owner: xcoo
• Created: 2020-03-24T08:28:43.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-02-08T05:50:26.000Z (about 2 years ago)
• Last Synced: 2024-10-28T13:37:19.805Z (4 months ago)
• Topics: clojure, jar
• Language: Clojure
• Homepage:
• Size: 110 KB
• Stars: 4
• Watchers: 9
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# metabill

[![Clojars Project](https://img.shields.io/clojars/v/jp.xcoo/metabill.svg)](https://clojars.org/jp.xcoo/metabill)

[![Clojars Project](https://img.shields.io/clojars/v/jp.xcoo/lein-metabill.svg)](https://clojars.org/jp.xcoo/lein-metabill)

A tiny library to handle the build meta information.

## Prepare

Put `jp.xcoo/metabill` into the `dependencies` and `jp.xcoo/lein-metabill` into the `plugins` of your leiningen's `project.clj`.

And run `lein metabill` before building for production, then it automatically generates `resources/metabill.edn`, which has some build metadata.

The default configuration of leiningen includes the `resources` directory as the classpath, so you don't need to do more.

Note that if you have modified `resource-paths`, you need to add `metabill.edn` to the classpath.

## Usage

### Avoid browser's caching

You can prevent browsers from caching old JS and CSS files using `with-build-time`:

```clojure

(ns hello-world.view

  (:require [hiccup.page :refer [html5 include-css include-js]]

            [metabill.core :refer [with-build-time]]))

(defn frame

  [req]

  (html5

   [:head

    [:title "Hello World!"]

    [:meta {:charset "utf-8"}]

    (include-css (with-build-time "/css/main.css"))]

   [:body

    [:div#app]

    (include-js (with-build-time "/js/main.js"))]))

```

![network](img/network.png)

You can also use commit hash:

```clojure

(ns hello-world.view

  (:require [hiccup.page :refer [html5 include-css include-js]]

            [metabill.core :refer [with-build-commit-hash]]))

(defn frame

  [req]

  (html5

   [:head

    [:title "Hello World!"]

    [:meta {:charset "utf-8"}]

    (include-css (with-build-commit-hash "/css/main.css"))]

   [:body

    [:div#app]

    (include-js (with-build-commit-hash "/js/main.js"))]))

```

### Embed meta information of the build

If you want to handle only the build metadata, you can use it as follows:

```clojure

(ns hello-world.core

  (:require [metabill.core :refer [get-build-time get-build-commit-hash]]))

(defn print-build-info

  []

  (println "This system is built on" (get-build-commit-hash) "commit at" (get-build-time) "unix epoc."))

```

## License

Copyright [Xcoo, Inc.][xcoo]

Licensed under the [Apache License, Version 2.0][apache-license-2.0].

[xcoo]: https://xcoo.jp/

[apache-license-2.0]: http://www.apache.org/licenses/LICENSE-2.0.html