Releasing
=========

1. Update `CHANGELOG.md`.

2. Set versions:

    ```
    export RELEASE_VERSION=X.Y.Z
    export NEXT_VERSION=X.Y.Z-SNAPSHOT
    ```

3. Update versions, tag the release, and prepare for the next release.

    ```
    sed -i "" \
      "s/version = \".*\"/version = \"$RELEASE_VERSION\"/g" \
      build.gradle.kts
    sed -i "" \

# -----
*.hprof

# Work dirs
# ---------
/incoming-distributions
/intTestHomeDir

# Logs
# ----
/*.log

# Thread dumps for troubleshooting
*.threaddump
# ps output for cleaning up leaking Java processes
*.psoutput

# oh-my-zsh gradle plugin
.gradletasknamecache

# Added GE support maven support to the maven build in .teamcity, per the GE docs, this dir is NOT to be committed

Previously, there was no formalization of property naming; only loose conventions were followed.
While these conventions served relatively well in practice, they created gaps, resulting in a loss of uniformity in some cases and leaving friction in the process of naming new properties.

### Terminology

**Public properties** are formally a part of the Public API.
Public properties are **stable properties**: they CANNOT be renamed or removed without notice.

    assertEquals(Country.class, bimap.valueType());
  }

  public void testIterationOrder() {
    // The enum orderings are alphabetical, leading to the bimap and its inverse
    // having inconsistent iteration orderings.
    Map<Currency, Country> map =
        ImmutableMap.of(
            Currency.DOLLAR, Country.CANADA,

        Element heading = document.body().select("h2").first();

        List<Element> inSection = new ArrayList<>();
        inSection.add(heading);

        Element next = heading.nextElementSibling();
        while (true) {
            if (next == null || next.tagName().equals("h2")) {
                Element section = heading.before("<section class='topic'/>").previousElementSibling();

* 100% test coverage: cobertura de tests del 100%
* back and forth: de un lado a otro
* I/O (as in "input and output"): I/O (do not translate to "E/S")
* Machine Learning: Machine Learning (do not translate to "Aprendizaje Automático")
* Deep Learning: Deep Learning (do not translate to "Aprendizaje Profundo")
* callback hell: callback hell (do not translate to "infierno de callbacks")
* tip: Consejo (do not translate to "tip")

            assertEquals("2001:db8::1", method.invoke(null, "2001:0db8:0000:0000:0000:0000:0000:0001"));
            assertEquals("fe80::1", method.invoke(null, "fe80:0000:0000:0000:0000:0000:0000:0001"));

            // Leading zeros removed and consecutive zeros compressed
            assertEquals("2001:db8::1", method.invoke(null, "2001:0db8:0:0:0:0:0:1"));

            // Longest sequence of zeros compressed (3 zeros at end vs 1 zero at start)

Java serialization is inherently Java-centric and does not support cross-language scenarios well.

- **Type Safety:**
Java serialization does not enforce type safety as strictly as some alternatives, potentially leading to runtime errors.

## Decision

We do not use Java serialization.
Instead, we use custom serialization where we explicitly describe how data objects should be serialized and deserialized.

    assertThat(letters).containsExactly("a", "b", "c", "").inOrder();
  }

  public void testCharacterSplitWithLeadingDelimiter() {
    String leading = ",a,b,c";
    Iterable<String> letters = COMMA_SPLITTER.split(leading);
    assertThat(letters).containsExactly("", "a", "b", "c").inOrder();
  }

  public void testCharacterSplitWithMultipleLetters() {
    Iterable<String> testCharacteringMotto =

 */
public interface IndexExportFormatter {

    /**
     * Returns the file extension for this format (e.g. ".html", ".json").
     *
     * @return the file extension including the leading dot
     */
    String getFileExtension();

    /**
     * Returns the default index file name for this format (e.g. "index.html", "index.json").
     *
     * @return the index file name
     */