Skip to content

Commit

Permalink
docs: remove redundant stuff from readme; cli usage
Browse files Browse the repository at this point in the history
  • Loading branch information
wzslr321 committed Aug 19, 2024
1 parent 5ca84c1 commit 5fe8a28
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 16 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
/target
example/repo/
example/repo*/
53 changes: 38 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,37 +7,60 @@ Impactifier is a tool designed to analyze and visualize the impact of code chang
2. [Key Features](#key-features)
3. [Roadmap](#roadmap)
4. [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
5. [Architecture](#architecture)
- [CI/CD](#cicd)
- [CLI](#cli)
6. [Contributing](#contributing)
7. [License](#license)

## Overview

Impactifier provides an automated approach to change impact analysis, specifically tailored for monorepos and CQRS architectures. By analyzing the codebase, it can identify which parts of the system are affected by changes in handlers or contracts, generating detailed reports that can be integrated into CI/CD pipelines.
Impactifier provides an automated approach to change impact analysis, initally designed to serve as CI/CD tool.
Aims to improve frequency and reliabilty of releases, by generating impact reports for engineers to be able to push the changes with confidance.
(Eventually) Higly configurable, with possibility to add custom rules. Your contracts generator does weird stuff under the hood, yet you want to
see what impact on front-end modyfing its query handler have? Don't worry, *Impactifier* got your back.

## Key Features

- **Automated Impact Analysis:** Detect changes and their potential effects across the codebase.
- **CQRS Support:** Special focus on handling changes in CQRS-based architectures.
- **Configurable rules specification:** Analyses the impact based on configurable set of rules, to support various tech-stacks.
- **Integration with CI/CD Pipelines:** Seamlessly integrate with GitHub Actions to provide impact reports in pull requests.
- **Future Expansion:** Plans to support REST API contracts and multi-repo setups.
- **Performance:** Built in Rust for high performance and low latency.
- **Performance:** Built in Rust for high performance and low latency. After all, it is all about faster releases.

## Roadmap
We are continuously improving Impactifier. Here’s a look at our planned features:

Support for REST APIs: Analyze impact for RESTful services.
Multi-repo Support: Extend functionality to projects with multiple repositories.
Enhanced Reporting: Develop advanced graphical reports and visualization tools.
Check out our Roadmap for more details.
We want to support specyfing more detailed context of analysis, such as:
- specific file and directory/file:
`$ impactifier . features/auth --to-branch develop` - Analyse current file and its impact regarding
current state of `--to-branch`'s `./feautres/auth` directory


## Getting Started

TODO:
### CI/CD

### CLI

**Impactifier** can be used as a CLI tool.

It can either clone a repository or open an existing - in you local file path - one.

To clone a repository you have to specify its url via `--url` flag.
If repository is private, you need to pass `--access-token` flag.

Example:
```sh
$ impactifier --url github.com/wzslr321/foobar --access-token=very_private
```

The commend above will actually allow you to perform your first impact analysis!
Since there is no further configuration, it will try to go with defaults, which are
your local changes & current branch - so basically just output of plain `git diff`

To specify what exactly you want to analyze, you have a few options:
- `--from-branch`: branch to compare, defaults to the current branch
- `--to-branch`: branch to compare the one from `--from_branch` with
- `--commit-id`: specific commit to analze
To specify the branch where the commit is located, use `--from-branch`

## Contributing
We welcome contributions to Impactifier! Please refer to our [Contributing Guidelines](CONTRIBUTING.md) for instructions on how to contribute.
Expand Down

0 comments on commit 5fe8a28

Please sign in to comment.