Skip to content

Commit

Permalink
Update chenagelog and readme for version 0.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
breezerider committed Oct 29, 2023
1 parent 3593510 commit 2b32e79
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 3 deletions.
25 changes: 25 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,30 @@
# Change Log

## [0.2.0] - 2023-10-28

### Added

- Backup files rotation based on modified date.
- Command line switch to provide custom configuration.
- RemoveFile function to StorageBackend interface
- GenerateDummyFiles that generates dummy file info for DummyBackend.ListFiles
- Getters for FileInfo fields
- SetDefaultValues pointer receiver that resets fields of Config struct to default values
- Implement new handler for command line arguments

### Fixed

- Refactor & extend test suite.
- Various spelling mistakes.

### Changed

- Expect second command line argument to be path to a prefix on storage backend (no longer a path to file).
- Add '.age' to file extension only when encryption is enabled.
- LoadConfigFromFile and LoadConfigFromEnv are now pointer receivers of Config.
- Run as local user in docker container during build and test.
- Mount local go build cache into the docker container during build and test.

## [0.1.0] - 2023-09-17

_First release._
Expand Down
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,22 @@ Then it will store the output file to a storage backen (currently only BackBlaze

```shell
$ squirrelup
Usage: squirrelup backup_dir output_uri
create an (optionally) encrypted gzip-compressed TAR file and upload it to storage backend.
At the moment only BackBlaze B2 cloud storage is implemented.
Usage: squirrelup <backup_dir> <output_prefix_uri>
Create an (optionally) encrypted gzip-compressed TAR file and upload it to storage backend.
At the moment only BackBlaze B2 cloud storage is implemented.

Required arguments:
<backup_dir> Path to local directory that serves as backup root.
<output_prefix_uri> Remote URI prefix.

Optional arguments:
--config, -c <config_file> Path to local config file.
--verbose, -v Verbose output.

BackBlaze B2 Backend:
<output_prefix_uri> must follow the pattern 'b2://<bucket>/<path>/<to>/<prefix>/'.

Default configuration is stored under <config_path>.
```

## Requirements
Expand All @@ -31,6 +44,14 @@ Build squirrelup by running:
make build
```

## Test

Run the test suite for squirrelup by running:

```shell
make test
```

## Acknowledgements

Project template generated using [inizio](https://github.com/insidieux/inizio)

0 comments on commit 2b32e79

Please sign in to comment.