Skip to content

Commit

Permalink
chore: update NEWS and release 1.4.3 (#799)
Browse files Browse the repository at this point in the history
* rename master to main
* update 1.4.3 in readme
  • Loading branch information
patriknw authored Oct 17, 2023
1 parent 3a4ebbf commit d279841
Show file tree
Hide file tree
Showing 9 changed files with 33 additions and 29 deletions.
4 changes: 4 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# 1.4.3: October 17, 2023

- Optionally hide rendered environment variables ([#798](/../../pull/798))

# 1.4.2: February 2, 2022

- Avoid instantiating arbitrary classes ([#758](/../../pull/758)) thanks to [@vlsi](https://github.com/vlsi) for the report and [@raboof](https://github.com/raboof) for the patch
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,12 +101,12 @@ You can find published releases on Maven Central.
<dependency>
<groupId>com.typesafe</groupId>
<artifactId>config</artifactId>
<version>1.4.2</version>
<version>1.4.3</version>
</dependency>

sbt dependency:

libraryDependencies += "com.typesafe" % "config" % "1.4.2"
libraryDependencies += "com.typesafe" % "config" % "1.4.3"

Link for direct download if you don't use a dependency manager:

Expand Down
6 changes: 3 additions & 3 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Making a release

To make a release you'll need to be a maintainer with GitHub
permissions to push to the master and gh-pages branches, and
permissions to push to the main and gh-pages branches, and
Sonatype permissions to publish.

Here are the steps, which should be automated but aren't (PR
Expand All @@ -22,9 +22,9 @@ welcome!):
9. make a separate clone of the repo in another directory and
check out the gh-pages branch
10. /bin/rm -rf latest/api on gh-pages checkout
11. copy config/target/api from master checkout to vX.Y.Z in
11. copy config/target/api from main checkout to vX.Y.Z in
gh-pages so you have vX.Y.Z/index.html
12. copy config/target/api from master checkout into latest/
12. copy config/target/api from main checkout into latest/
so you have latest/api/index.html
13. commit all that to gh-pages, check the diff for sanity
(latest/api should be mostly just changed timestamps)
Expand Down
20 changes: 10 additions & 10 deletions config/src/main/java/com/typesafe/config/Config.java
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
*
* <p>
* You can find an example app and library <a
* href="https://github.com/lightbend/config/tree/master/examples">on
* href="https://github.com/lightbend/config/tree/main/examples">on
* GitHub</a>. Also be sure to read the <a
* href="package-summary.html#package_description">package overview</a> which
* describes the big picture as shown in those examples.
Expand All @@ -56,7 +56,7 @@
* in a JSON object; it's just a string that's the key in a map. A "path" is a
* parseable expression with a syntax and it refers to a series of keys. Path
* expressions are described in the <a
* href="https://github.com/lightbend/config/blob/master/HOCON.md">spec for
* href="https://github.com/lightbend/config/blob/main/HOCON.md">spec for
* Human-Optimized Config Object Notation</a>. In brief, a path is
* period-separated so "a.b.c" looks for key c in object b in object a in the
* root object. Sometimes double quotes are needed around special characters in
Expand Down Expand Up @@ -110,7 +110,7 @@
* <p>
* <em>Substitutions</em> are the <code>${foo.bar}</code> syntax in config
* files, described in the <a href=
* "https://github.com/lightbend/config/blob/master/HOCON.md#substitutions"
* "https://github.com/lightbend/config/blob/main/HOCON.md#substitutions"
* >specification</a>. Resolving substitutions replaces these references with real
* values.
*
Expand Down Expand Up @@ -189,7 +189,7 @@ public interface Config extends ConfigMergeable {
/**
* Returns a replacement config with all substitutions (the
* <code>${foo.bar}</code> syntax, see <a
* href="https://github.com/lightbend/config/blob/master/HOCON.md">the
* href="https://github.com/lightbend/config/blob/main/HOCON.md">the
* spec</a>) resolved. Substitutions are looked up using this
* <code>Config</code> as the root object, that is, a substitution
* <code>${foo.bar}</code> will be replaced with the result of
Expand Down Expand Up @@ -670,7 +670,7 @@ public interface Config extends ConfigMergeable {
* the value is already a number, then it's left alone; if it's a string,
* it's parsed understanding unit suffixes such as "128K", as documented in
* the <a
* href="https://github.com/lightbend/config/blob/master/HOCON.md">the
* href="https://github.com/lightbend/config/blob/main/HOCON.md">the
* spec</a>.
*
* @param path
Expand All @@ -690,7 +690,7 @@ public interface Config extends ConfigMergeable {
* the value is already a number, then it's left alone; if it's a string,
* it's parsed understanding unit suffixes such as "128K", as documented in
* the <a
* href="https://github.com/lightbend/config/blob/master/HOCON.md">the
* href="https://github.com/lightbend/config/blob/main/HOCON.md">the
* spec</a>.
*
* @since 1.3.0
Expand All @@ -711,7 +711,7 @@ public interface Config extends ConfigMergeable {
* Get value as a duration in milliseconds. If the value is already a
* number, then it's left alone; if it's a string, it's parsed understanding
* units suffixes like "10m" or "5ns" as documented in the <a
* href="https://github.com/lightbend/config/blob/master/HOCON.md">the
* href="https://github.com/lightbend/config/blob/main/HOCON.md">the
* spec</a>.
*
* @deprecated As of release 1.1, replaced by {@link #getDuration(String, TimeUnit)}
Expand Down Expand Up @@ -754,7 +754,7 @@ public interface Config extends ConfigMergeable {
* number, then it's taken as milliseconds and then converted to the
* requested TimeUnit; if it's a string, it's parsed understanding units
* suffixes like "10m" or "5ns" as documented in the <a
* href="https://github.com/lightbend/config/blob/master/HOCON.md">the
* href="https://github.com/lightbend/config/blob/main/HOCON.md">the
* spec</a>.
*
* @since 1.2.0
Expand All @@ -778,7 +778,7 @@ public interface Config extends ConfigMergeable {
* already a number, then it's taken as milliseconds; if it's
* a string, it's parsed understanding units suffixes like
* "10m" or "5ns" as documented in the <a
* href="https://github.com/lightbend/config/blob/master/HOCON.md">the
* href="https://github.com/lightbend/config/blob/main/HOCON.md">the
* spec</a>. This method never returns null.
*
* @since 1.3.0
Expand All @@ -800,7 +800,7 @@ public interface Config extends ConfigMergeable {
* already a number, then it's taken as days; if it's
* a string, it's parsed understanding units suffixes like
* "10d" or "5w" as documented in the <a
* href="https://github.com/lightbend/config/blob/master/HOCON.md">the
* href="https://github.com/lightbend/config/blob/main/HOCON.md">the
* spec</a>. This method never returns null.
*
* @since 1.3.0
Expand Down
4 changes: 2 additions & 2 deletions config/src/main/java/com/typesafe/config/ConfigFactory.java
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* from a resource and nothing else.
*
* <p> You can find an example app and library <a
* href="https://github.com/lightbend/config/tree/master/examples">on
* href="https://github.com/lightbend/config/tree/main/examples">on
* GitHub</a>. Also be sure to read the <a
* href="package-summary.html#package_description">package
* overview</a> which describes the big picture as shown in those
Expand Down Expand Up @@ -674,7 +674,7 @@ public static Config systemEnvironment() {
/**
* Converts a Java {@link java.util.Properties} object to a
* {@link ConfigObject} using the rules documented in the <a
* href="https://github.com/lightbend/config/blob/master/HOCON.md">HOCON
* href="https://github.com/lightbend/config/blob/main/HOCON.md">HOCON
* spec</a>. The keys in the <code>Properties</code> object are split on the
* period character '.' and treated as paths. The values will all end up as
* string values. If you have both "a=foo" and "a.b=bar" in your properties
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public interface ConfigMergeable {
*
* <p>
* The semantics of merging are described in the <a
* href="https://github.com/lightbend/config/blob/master/HOCON.md">spec
* href="https://github.com/lightbend/config/blob/main/HOCON.md">spec
* for HOCON</a>. Merging typically occurs when either the same object is
* created twice in the same file, or two config files are both loaded. For
* example:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
/**
* A set of options related to resolving substitutions. Substitutions use the
* <code>${foo.bar}</code> syntax and are documented in the <a
* href="https://github.com/lightbend/config/blob/master/HOCON.md">HOCON</a>
* href="https://github.com/lightbend/config/blob/main/HOCON.md">HOCON</a>
* spec.
* <p>
* Typically this class would be used with the method
Expand Down
4 changes: 2 additions & 2 deletions config/src/main/java/com/typesafe/config/ConfigSyntax.java
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

/**
* The syntax of a character stream (<a href="http://json.org">JSON</a>, <a
* href="https://github.com/lightbend/config/blob/master/HOCON.md">HOCON</a>
* href="https://github.com/lightbend/config/blob/main/HOCON.md">HOCON</a>
* aka ".conf", or <a href=
* "http://download.oracle.com/javase/7/docs/api/java/util/Properties.html#load%28java.io.Reader%29"
* >Java properties</a>).
Expand All @@ -21,7 +21,7 @@ public enum ConfigSyntax {
JSON,
/**
* The JSON-superset <a
* href="https://github.com/lightbend/config/blob/master/HOCON.md"
* href="https://github.com/lightbend/config/blob/main/HOCON.md"
* >HOCON</a> format. Associated with the <code>.conf</code> file extension
* and <code>application/hocon</code> Content-Type.
*/
Expand Down
16 changes: 8 additions & 8 deletions config/src/main/java/com/typesafe/config/package.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<p>
Typically you would load configuration with a static method from {@link com.typesafe.config.ConfigFactory} and then use
it with methods in the {@link com.typesafe.config.Config} interface. Configuration may be in the form of JSON files,
Java properties, or <a href="https://github.com/lightbend/config/blob/master/HOCON.md">HOCON files</a>; you may also
Java properties, or <a href="https://github.com/lightbend/config/blob/main/HOCON.md">HOCON files</a>; you may also
build your own configuration in code or from your own file formats.
</p>

Expand All @@ -26,8 +26,8 @@
If you use the default configuration from {@link com.typesafe.config.ConfigFactory#load()}
there's no need to pass a configuration to your libraries
and frameworks, as long as they all default to this same default, which they should.
<br/><strong>Example application code:</strong> <a href="https://github.com/lightbend/config/tree/master/examples/java/simple-app/src/main">Java</a> and <a href="https://github.com/lightbend/config/tree/master/examples/scala/simple-app/src/main">Scala</a>.
<br/>Showing a couple of more special-purpose features, <strong>a more complex example:</strong> <a href="https://github.com/lightbend/config/tree/master/examples/java/complex-app/src/main">Java</a> and <a href="https://github.com/lightbend/config/tree/master/examples/scala/complex-app/src/main">Scala</a>.
<br/><strong>Example application code:</strong> <a href="https://github.com/lightbend/config/tree/main/examples/java/simple-app/src/main">Java</a> and <a href="https://github.com/lightbend/config/tree/main/examples/scala/simple-app/src/main">Scala</a>.
<br/>Showing a couple of more special-purpose features, <strong>a more complex example:</strong> <a href="https://github.com/lightbend/config/tree/main/examples/java/complex-app/src/main">Java</a> and <a href="https://github.com/lightbend/config/tree/main/examples/scala/complex-app/src/main">Scala</a>.
</p>

<p>
Expand All @@ -36,21 +36,21 @@
call {@link com.typesafe.config.ConfigFactory#load()}
to get the default one. Typically a library might offer two constructors, one with a <code>Config</code> parameter
and one which uses {@link com.typesafe.config.ConfigFactory#load()}.
<br/><strong>Example library code:</strong> <a href="https://github.com/lightbend/config/tree/master/examples/java/simple-lib/src/main">Java</a> and <a href="https://github.com/lightbend/config/tree/master/examples/scala/simple-lib/src/main">Scala</a>.
<br/><strong>Example library code:</strong> <a href="https://github.com/lightbend/config/tree/main/examples/java/simple-lib/src/main">Java</a> and <a href="https://github.com/lightbend/config/tree/main/examples/scala/simple-lib/src/main">Scala</a>.
</p>

<p>
Check out the full <a href="https://github.com/lightbend/config/tree/master/examples">examples directory on GitHub</a>.
Check out the full <a href="https://github.com/lightbend/config/tree/main/examples">examples directory on GitHub</a>.
</p>

<p>
What else to read:
<ul>
<li>The overview documentation for interface {@link com.typesafe.config.Config}.</li>
<li>The <a href="https://github.com/lightbend/config/blob/master/README.md">README</a> for the library.</li>
<li>The <a href="https://github.com/lightbend/config/blob/main/README.md">README</a> for the library.</li>
<li>If you want to use <code>.conf</code> files in addition to <code>.json</code> and <code>.properties</code>,
see the <a href="https://github.com/lightbend/config/blob/master/README.md">README</a> for some short examples
and the full <a href="https://github.com/lightbend/config/blob/master/HOCON.md">HOCON spec</a> for the long version.</li>
see the <a href="https://github.com/lightbend/config/blob/main/README.md">README</a> for some short examples
and the full <a href="https://github.com/lightbend/config/blob/main/HOCON.md">HOCON spec</a> for the long version.</li>
</ul>
</p>

Expand Down

0 comments on commit d279841

Please sign in to comment.