Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate to new configuration asciidoc macro and build plugin 5.4.5 #552

Merged
merged 2 commits into from
Feb 23, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/graalvm.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
java: ['11', '17']
graalvm: ['latest', 'dev']
java: ['17']
graalvm: ['latest']
steps:
# https://github.com/actions/virtual-environments/issues/709
- name: Free disk space
Expand Down
2 changes: 1 addition & 1 deletion settings.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ pluginManagement {
}

plugins {
id 'io.micronaut.build.shared.settings' version '5.3.14'
id 'io.micronaut.build.shared.settings' version '5.4.5'
}

rootProject.name = 'cache-parent'
Expand Down
5 changes: 2 additions & 3 deletions src/main/docs/guide/cache-abstraction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,9 @@ NOTE: This module is built and tested with Caffeine {caffeineVersion}
dependency:io.micronaut.cache:micronaut-cache-caffeine[]


Then configure one or many caches. For example with `application.yml`:
Then configure one or many caches. For example with the application configuration:

.Cache Configuration Example
[source,yaml]
[configuration, title = 'Cache Configuration Example']
----
micronaut:
caches:
Expand Down
16 changes: 8 additions & 8 deletions src/main/docs/guide/ehcache.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ dependency:io.micronaut.cache:micronaut-cache-ehcache:{version}[]

To have Micronaut create a cache, the minimum configuration is:

[source,yaml]
[configuration]
----
ehcache:
caches:
Expand All @@ -29,7 +29,7 @@ If no tier is explicitly configured, the cache will be configured with a heap ti

It can be sized by number of entries:

[source,yaml]
[configuration]
----
ehcache:
caches:
Expand All @@ -40,7 +40,7 @@ ehcache:

Or by size:

[source,yaml]
[configuration]
----
ehcache:
caches:
Expand All @@ -51,7 +51,7 @@ ehcache:

=== Off-heap tier

[source,yaml]
[configuration]
----
ehcache:
caches:
Expand All @@ -65,7 +65,7 @@ intend to use.

=== Disk tier

[source,yaml]
[configuration]
----
ehcache:
storage-path: /var/caches
Expand All @@ -81,7 +81,7 @@ Ehcache supports distributed caching with http://www.terracotta.org[Terracotta]

This is a complete example configuration:

[source,yaml]
[configuration]
----
ehcache:
cluster:
Expand Down Expand Up @@ -114,7 +114,7 @@ options.

For example, to configure a heap + offheap + disk cache:

[source,yaml]
[configuration]
----
ehcache:
storage-path: /var/caches
Expand All @@ -126,4 +126,4 @@ ehcache:
max-size: 1Gb
disk:
max-size: 10Gb
----
----
3 changes: 1 addition & 2 deletions src/main/docs/guide/endpoint.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,7 @@ $ curl -X DELETE http://localhost:8080/caches

To configure the caches endpoint, supply configuration through `endpoints.caches`.

.Caches Endpoint Configuration Example
[source,yaml]
[configuration, title ='Caches Endpoint Configuration Example']
----
endpoints:
caches:
Expand Down
6 changes: 3 additions & 3 deletions src/main/docs/guide/hazelcast.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ $ mn create-app hello-world -f hazelcast
The minimal configuration to use Hazelcast is to simply declare `hazelcast:` with a network configuration for addresses of the
Hazelcast cluster (example below).

[source,yaml]
[configuration]
----
hazelcast:
network:
Expand Down Expand Up @@ -56,8 +56,8 @@ Alternatively, the `HazelcastClientConfiguration` or `HazelcastMemberConfigurati

To disable Hazelcast:

[source,yaml]
[configuration]
----
hazelcast:
enabled: false
----
----
8 changes: 4 additions & 4 deletions src/main/docs/guide/infinispan.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ By default, Micronaut will setup a
https://docs.jboss.org/infinispan/10.0/apidocs/org/infinispan/client/hotrod/RemoteCacheManager.html[`RemoteCacheManager`]
over `127.0.0.1:11222`. To define custom addresses:

[source,yaml]
[configuration]
----
infinispan:
client:
Expand Down Expand Up @@ -50,7 +50,7 @@ minIdle = 1

To read this file from a different classpath location:

[source,yaml]
[configuration]
----
infinispan:
client:
Expand All @@ -67,8 +67,8 @@ include::{includedir}configurationProperties/io.micronaut.cache.infinispan.Infin

To disable Infinispan:

[source,yaml]
[configuration]
----
infinispan:
enabled: false
----
----
4 changes: 2 additions & 2 deletions src/main/docs/guide/jcache.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ When there is a JSR 107 (JCache) implementation in the classpath (Ehcache, Hazel
abstraction will use the JCache API internally by default. If you want Micronaut to use the concrete implementation API,
JCache needs to be disabled:

[source,yaml]
[configuration]
----
micronaut:
jcache:
enabled: false
----
----
2 changes: 1 addition & 1 deletion src/main/docs/guide/noop.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ dependency:io.micronaut.cache:micronaut-cache-noop:{version}[]

The no operation cache manager needs to be enabled explicitly:

[source,yaml]
[configuration]
----
noop-cache.enabled: true
----