Skip to content

Commit

Permalink
docs: update README (ekristen#71)
Browse files Browse the repository at this point in the history
  • Loading branch information
ekristen authored and corybekk committed Nov 5, 2024
1 parent f512e38 commit d48d448
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,31 @@ Remove all resources from an AWS account.
*aws-nuke* is stable, but it is likely that not all AWS resources are covered by it. Be encouraged to add missing
resources and create a Pull Request or to create an [Issue](https://github.com/ekristen/aws-nuke/issues/new).

## What's New in Version 3!

Version 3 is a rewrite of this tool using [libnuke](https://github.com/ekristen/libnuke) with a focus on improving a number of the outstanding things
that I couldn't get done with the original project without separating out the core code into a library. See Goals
below for more.

### Notable Changes

- The root command will result in help now, the primary nuke command moved to `run` (alias: `nuke`). **Breaking Change**
- CloudFormation Stacks now support a hold and wait for parent deletion process. **New Behavior, Breaking Change**
- Nested CloudFormation Stacks are now eligible for deletion and no longer omitted. **New Behavior, Breaking Change**
- The entire resource lister format has changed and requires a struct to allow for more options going forward.
- Context is passed throughout the entire library now, including the listing function and the removal function.
- This is in preparation for supporting AWS SDK Go v2

### Goals

- [x] Easier maintainability and bug fixing, see go report and code climate badges above
- [x] Adding additional tests around the core library
- [ ] Adding more tests around specific resource types
- [x] Adding additional resources and tooling to make adding resources easier
- [x] Adding documentation for adding resources and using the tool
- [ ] Consider adding DAG for dependencies between resource types and individual resources
- [ ] Support for AWS SDK Go v2

## Documentation

All documentation is in the [docs/](docs) directory and is built using [Material for Mkdocs](https://squidfunk.github.io/mkdocs-material/).
Expand Down

0 comments on commit d48d448

Please sign in to comment.