Skip to content

Latest commit

 

History

History
79 lines (51 loc) · 2.42 KB

DEVELOPING.md

File metadata and controls

79 lines (51 loc) · 2.42 KB
Raw

Developing

Setting up the repo

Git Hooks

This repo uses git hooks for certain behaviors such as formatting before a push. To install the git hooks, run the following command at the root of your repo directory:

./INSTALL_HOOKS.sh

Building and Releasing

To locally publish the m2 repo:

./gradlew publishToMavenLocal

To generate a releasable m2 repo:

./gradlew publishAllPublicationsToMavenRepository

The m2 repo will be in /m2.

To generate Dokka for the generativeai project:

./gradlew generativeai:dokkaHtml

The docs will be in generativeai/build/dokka/html.

Making changes

When making changes that are intended to invoke a release, it's important to make sure a proper changelog entry accompanies your change. We use a custom plugin, alongside an executable bash script called change to better facilitate this process.

Changes are organized in the .changes directory at the root of the repo, and each change pending a release will be represented as a single file with a seemingly random string of words as a file name. This file will contain two vital pieces of information;

  • What the change is about (a user displayable message to use in the subsequent release notes)
  • The api impact of the change (will this require a major, minor, or patch bump?)

We have tooling that will automatically determine the impact of your changes, so all you need to do is run the following command from the root of the repo whenever you want to make a change that will invoke a release:

change "hello world!"

Alternatively, if you want to invoke a release without adding anything to the release notes come release time- you can run change without specifying a message:

change

Both of these commands should generate a new file under the .changes directory with your message and impact.

Note though, that this will naturally create release notes for all projects. If you only want to generate a change for the generativeai project, then prefix your message with the project name:

change generativeai "hello world!"

You can also do it for other projects as well, just supply the project name:

change common "hello world!"

Although, this does not support creating empty changes. You'll have to make that change manually, if that's what you want.

To learn more, read the section on our changelog plugin in our plugin readme.