git_ops - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #react #llm #go #machine-learning #rust #docker #windows #awesome #cli #kubernetes #pytorch #open-source

git_ops

(★ 155)

A tool for version and changelog management in Elixir via conventional commits.

File Explorer

Download Latest Version (.zip)

- settings.json
- config.exs
- monorepos.md
- - changelog.ex
  - commit.ex
  - config.ex
  - git.ex
  - github.ex
  - package.ex
  - version.ex
  - version_replace.ex
- git_ops.ex
- - commit-msg.template
- - monorepo_fixture.ex
- changelog_test.exs
- check_message_test.exs
- commit_test.exs
- config_test.exs
- git_ops_test.exs
- git_test.exs
- install_test.exs
- message_hook_test.exs
- packages_test.exs
- project_info_test.exs
- pull_request_test.exs
- release_test.exs
- test_helper.exs
- version_replace_test.exs
- version_test.exs
.credo.exs
.formatter.exs
.gitignore
.tool-versions
.travis.yml
CHANGELOG.md
LICENCE.md
mix.exs
mix.lock
PULL_REQUEST_TEMPLATE.md
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# GitOps

[![Hex pm](http://img.shields.io/hexpm/v/git_ops.svg?style=flat)](https://hex.pm/packages/git_ops)
[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/git_ops/)
[![Total Download](https://img.shields.io/hexpm/dt/git_ops.svg)](https://hex.pm/packages/git_ops)
[![License](https://img.shields.io/hexpm/l/git_ops.svg)](https://github.com/zachdaniel/git_ops/blob/master/LICENSE)

A small tool to help generate changelogs from conventional commit messages.
For more information, see [conventional
commits](https://conventionalcommits.org).
For an example, see this project's [CHANGELOG.md](https://github.com/zachdaniel/git_ops/blob/master/CHANGELOG.md).

Roadmap (in no particular order):

- More tests
- Automatically parse issue numbers and github mentions into the correct format, linking the issue
- A task to build a compliant commit
- Validation of commits
- A hundred other things I forgot to write down while writing the initial version

Important addendums:

A new version of the spec in beta adds a rather useful
convention. Add ! after the type/scope to simply signal it as a breaking
change, instead of adding `BREAKING CHANGE: description` in your commit message.
For example: `fix(Spline Reticulator)!: `

The spec doesn't specify behavior around multiple scopes. This library parses
scopes _as a comma separated list_. This allows for easily readable multiple
word lists `feat(Something Special, Something Else Special): message`. Keep in
mind that you are very limited on space in these messages, and if you find
yourself using multiple scopes your commit is probably too big.

## Installation with Igniter

If `Igniter` is not already in your project, add it to your deps:

```elixir
def deps do
  [
    {:igniter, "~> 0.5", only: [:dev, :test]}
  ]
end
```

Then, run the installer:

```sh
mix igniter.install git_ops
```

## Manual Installation

```elixir
def deps do
  [
    {:git_ops, "~> 2.6.1", only: [:dev]}
  ]
end
```

## Configuration

```elixir
config :git_ops,
  mix_project: Mix.Project.get!(),
  changelog_file: "CHANGELOG.md",
  
  # if set to true, this uses git user.email to lookup user on github and insert the handle in release notes
  # otherwise it uses the author name as provided in the commit
  github_handle_lookup?: true,
  github_api_base_url: "https://api.github.com",
  
  repository_url: "https://github.com/my_user/my_repo",
  types: [
    # Makes an allowed commit type called `tidbit` that is not
    # shown in the changelog
    tidbit: [
      hidden?: true
    ],
    # Makes an allowed commit type called `important` that gets
    # a section in the changelog with the header "Important Changes"
    important: [
      header: "Important Changes"
    ]
  ],
  tags: [
    # Only add commits to the changelog that has the "backend" tag
    allowed: ["backend"],
    # Filter out or not commits that don't contain tags
    allow_untagged?: true
  ],
  # Instructs the tool to manage your mix version in your `mix.exs` file
  # See below for more information
  manage_mix_version?: true,
  # Instructs the tool to manage the version in your README.md
  # Pass in `true` to use `"README.md"` or a string to customize
  manage_readme_version: "README.md",
  # Manage an arbitrary list of files during release.
  # See "Managing additional files" below for details.
  managed_files: [
    {"apps/my_app/mix.exs", :mix},
    {"README.md", :string}
  ],
  version_tag_prefix: "v",
  # Where the current version is read from:
  # :mix (default) reads the configured mix_project's version,
  # :tags reads the last valid version tag, and
  # {:file, path, regex} reads the regex's first capture group from path.
  # :tags and {:file, ...} need no mix project, enabling non-Elixir projects.
  version_source: :mix
```

## Configuration with `git_ops.json`

A `git_ops.json` file at the repository root takes precedence over the
application environment, and is how repositories without a mix project — or
with more than one package — configure git_ops. With a config file the
current version is read from tags by default (`version_source: "tags"`), so
no mix project is required.

```json
{
  "repository_url": "https://github.com/my_user/my_repo",
  "types": {"docs": {"hidden": true}, "important": {"header": "Important Changes"}},
  "version_tag_prefix": "v",
  "managed_files": [{"path": "package.json", "type": "json"}]
}
```

`managed_files` entries take a `type` (`"mix"`, `"json"` for a
`"version": "..."` field, `"raw"` for a file whose whole content is the
version, or `"string"`) or a custom `"pattern"` template in which
`{version}` is replaced.

### Monorepos and pull-request releases

A `packages` map in `git_ops.json` releases each directory independently —
its own `<name>-v` tags, changelog, and managed files — and
`"release_strategy": "pull_request"` proposes releases as pull requests
whose merge is the release (with `mix git_ops.tag_merged` reconciling tags
and GitHub releases afterwards). See the
[Monorepos guide](documentation/monorepos.md).

Getting started:

```bash
mix git_ops.release --initial
```

Commit the result of that, using a message like `chore: Initial Release`

Then when you want to release again, use:

```bash
mix git_ops.release
```

For the full documentation of that task, see the task documentation in hex.

## Managing your mix version

To have mix manage your mix version, add `manage_mix_version?: true` to your configuration.

Then, use a module attribute called `@version` to manage your application's
version. Look at [this project's mix.exs](mix.exs) for an example.

## Managing your readme version

Most project readmes have a line like this that would ideally remain up to date:

```elixir
    {:git_ops, "~> 2.6.1", only: [:dev]}
```

You can keep that number up to date via `manage_readme_version`, which accepts
`true` for `README.md` or a string pointing to some other path relative to your
project root.

## Managing additional files

For projects that need to update version strings in multiple files (e.g. poncho
apps with several `mix.exs` files), use the `managed_files` option:

```elixir
config :git_ops,
  managed_files: [
    {"apps/my_app/mix.exs", :mix},
    {"apps/my_other_app/mix.exs", :mix},
    {"README.md", :string},
    {"package.json", fn v -> "\"version\": \"#{v}\"" end, fn v -> "\"version\": \"#{v}\"" end}
  ]
```

Each entry is a tuple describing a file and how to find/replace the version
string within it:

- `{path, :mix}` — replaces `@version "x.y.z"` (same pattern as `manage_mix_version?`)
- `{path, :string}` — replaces `"~> x.y.z"` (same pattern as `manage_readme_version`)
- `{path, replace_fn, pattern_fn}` — custom functions that each take a version
  string and return the text to find/replace

The `managed_files` list is merged with any files contributed by
`manage_mix_version?` and `manage_readme_version`, so you can use all three
options together or migrate to `managed_files` entirely.

## Using this with open source projects

If you'd like your contributors to use the conventional commit format, you can
use a PULL_REQUEST_TEMPLATE.md like the one in our repo. However,
it is also possible to manage it as the maintainers of a project by altering
either the merge commit or alter the commit when merging/squashing (recommended)

## Similar projects

- https://github.com/glasnoster/eliver
- https://github.com/oo6/mix-bump
- https://github.com/mpanarin/versioce