From a001358549572561cf6cfcd36e6d0978a36c49ce Mon Sep 17 00:00:00 2001 From: DanCardin Date: Tue, 20 Feb 2024 13:26:10 -0500 Subject: [PATCH] Release 0.8.5. --- .github/workflows/release.yml | 5 ++ CHANGELOG.md | 127 +++++++++++++++++++++++++++++++++- docs/source/config/table.md | 20 ++++++ pyproject.toml | 2 +- 4 files changed, 152 insertions(+), 2 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 27933f9..c8f172d 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -36,6 +36,11 @@ jobs: poetry config pypi-token.pypi $PYPI_TOKEN poetry publish --build + publish-dockerhub: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Login to Docker Hub uses: docker/login-action@v2 with: diff --git a/CHANGELOG.md b/CHANGELOG.md index af8b534..34bd086 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,134 @@ # Changelog -## [Unreleased](https://github.com/schireson/databudgie/compare/v2.7.0...HEAD) (2022-11-10) +### [v2.8.5](https://github.com/schireson/databudgie/compare/v2.8.4...v2.8.5) (2024-02-20) + +#### Features + +* Allow specifying filename as a field. + ([0a47ce8](https://github.com/schireson/databudgie/commit/0a47ce88ccc73e860afcc57c8f5715a6b1b28ef5)) + +#### Fixes + +* Bump all the docs dependencies. + ([cb36920](https://github.com/schireson/databudgie/commit/cb3692075df9319c55ece54b3df31fceddf006de)) +* Add stub docs package. + ([a555760](https://github.com/schireson/databudgie/commit/a5557608a92a8f707389949b3f21409e48e758bf)) +* Sphinx docs. + ([69f4f6e](https://github.com/schireson/databudgie/commit/69f4f6ed0732710386128f99761454b6a454412a)) + +### [v2.8.4](https://github.com/schireson/databudgie/compare/v2.8.3...v2.8.4) (2023-07-06) + +#### Features + +* Allow unnamed tables. + ([a5a670f](https://github.com/schireson/databudgie/commit/a5a670f78284fb4f3b287f42771a4d6c7b70265b)) +* Simplify programmatic api. + ([2d4a4d0](https://github.com/schireson/databudgie/commit/2d4a4d0d7adc66afcf5d8d7cdcef6794dfdf03fc)) + +#### Fixes + +* Apply minimum bound to configly. + ([f0d4dba](https://github.com/schireson/databudgie/commit/f0d4dba12e606af1c6847bb5ccd2c47ee9e30677)) +* root_path composition of s3 paths. + ([51be9a7](https://github.com/schireson/databudgie/commit/51be9a7de754a49e92669e878997076e6a85525b)) + +### [v2.8.3](https://github.com/schireson/databudgie/compare/v2.8.2...v2.8.3) (2023-06-21) + +#### Features + +* Add skip_if_exists per-table option for backups. + ([e0bd4f2](https://github.com/schireson/databudgie/commit/e0bd4f200bec404dbb2e6c79b65e7987bd8f894a)) + +#### Fixes + +* Dont assume later versions of configly. + ([c4991ad](https://github.com/schireson/databudgie/commit/c4991adaf6b3ea2809efcbe2c3b9dfb51224ef15)) +* Re-point docker build tag names. + ([aecb058](https://github.com/schireson/databudgie/commit/aecb0587972ea62b90089fb2665c2c6588ae6c0a)) + +### [v2.8.2](https://github.com/schireson/databudgie/compare/v2.8.1...v2.8.2) (2023-06-12) + +#### Features + +* Use correct secrets names. + ([2380701](https://github.com/schireson/databudgie/commit/23807018d9c02039bd6516cda23fb25699301e12)) +* Route --conn through config so that config-level "connection:" field works in +the same way. + ([f238c30](https://github.com/schireson/databudgie/commit/f238c30212586ac316d599aede28f85bfdf67307)) + +### [v2.8.1](https://github.com/schireson/databudgie/compare/v2.8.0...v2.8.1) (2023-06-08) + +#### Fixes + +* capitalization + ([1e8bd20](https://github.com/schireson/databudgie/commit/1e8bd20c493867b8e0b50a342df23db107a3f982)) + +## [v2.8.0](https://github.com/schireson/databudgie/compare/v2.7.5...v2.8.0) (2023-05-02) + +### Features + +* Publish dockerhub databudgie image. + ([80fbe97](https://github.com/schireson/databudgie/commit/80fbe97f554b8c3ed6b461a9a1587dacfc450fb4)) +* Allow specifying config through stdin/raw config cli option. + ([88146e5](https://github.com/schireson/databudgie/commit/88146e56e13d47b423dd2af1d5f5e5a7b80063b3)) +* Allow setting configuration through environment variables. + ([6a005dd](https://github.com/schireson/databudgie/commit/6a005dd6905662b23e90f27f23e593cd48acf7c9)) +* databudgie.yml/json/toml + ([0b63b43](https://github.com/schireson/databudgie/commit/0b63b4383306d66ff308514247354d4518904bed)) ### Fixes +* Bug where table level disablement wouldnt have taken effect based on +parent-level enablement. + ([5f23c07](https://github.com/schireson/databudgie/commit/5f23c072f503b890c010171223cde6a9a21d8dc4)) + +### [v2.7.5](https://github.com/schireson/databudgie/compare/v2.7.4...v2.7.5) (2023-04-21) + +#### Fixes + +* Avoid weird python behavior that ignores path components with absolute paths. + ([6d97bce](https://github.com/schireson/databudgie/commit/6d97bcedb4d2829989855ac4658c2808f7b1920b)) + +### [v2.7.4](https://github.com/schireson/databudgie/compare/v2.7.2...v2.7.4) (2023-04-21) + +#### Features + +* Implement dry-run/stats. + ([ffe6e95](https://github.com/schireson/databudgie/commit/ffe6e95606d57298e3f6d9a5b5e5b6a5a8fe4ad1)) +* Exclusion from the cli. + ([4dfbf36](https://github.com/schireson/databudgie/commit/4dfbf36057b4b1fb38a4584185581c2aa4c922fa)) +* Add option to define named connections. + ([58df61e](https://github.com/schireson/databudgie/commit/58df61e21b816a9af8e9d7e8092ffe7438cafa9a)) + +#### Fixes + +* s3 stuff. + ([4d3d978](https://github.com/schireson/databudgie/commit/4d3d978a46cf3d33ffe0ab02a5d1c1f6c5149faa)) +* Ensure s3 paths are composed correctly, with root_location. + ([64d89c2](https://github.com/schireson/databudgie/commit/64d89c2588d5584b3f692b6a0f4a8089e5b24198)) +* Add .sql extension to sql files. + ([cdc8775](https://github.com/schireson/databudgie/commit/cdc8775db50d7e2d945953c14ab5de96c1a1def8)) + +### [v2.7.2](https://github.com/schireson/databudgie/compare/v2.7.1...v2.7.2) (2023-01-12) + +#### Features + +* Support sqlalchemy 2.0. + ([edbc9fc](https://github.com/schireson/databudgie/commit/edbc9fc1378f8ee78b0120eaebf934cf6a4250c9)) + +#### Fixes + +* Put release CI in the correct folder. + ([878b386](https://github.com/schireson/databudgie/commit/878b386ce4ddf011d2db65b089bc4ab882822c7f)) +* Issue where locations fallback value was overridden by empty string. + ([27d3d40](https://github.com/schireson/databudgie/commit/27d3d4041df22dbc4f5604fcbfae31afeb01c93d)) +* Issues from release. + ([48c0d75](https://github.com/schireson/databudgie/commit/48c0d75d2b8d492d7490989cd932b2ff1e53758f)) + +### [v2.7.1](https://github.com/schireson/databudgie/compare/v2.7.0...v2.7.1) (2022-11-10) + +#### Fixes + * Issues from release. ([15066df](https://github.com/schireson/databudgie/commit/15066df96dcb40bd9dd2fc54454ff4ac7e0a0664)) diff --git a/docs/source/config/table.md b/docs/source/config/table.md index 14e5c63..3e25783 100644 --- a/docs/source/config/table.md +++ b/docs/source/config/table.md @@ -96,6 +96,12 @@ Defaults to `backups/{table}` `location` paths use URI protocols for determining (on a per path basis) what protocol to use for the backup/restore of that path. +```{tip} +Output files default to being separated into table-specific folder through +`{table}`. They can be colocated regardless of folder by removing that template +source e.x. `backups/`. +``` + ### Local files Note an otherwise unadorned path will be assumed to be a local file path, for @@ -117,6 +123,20 @@ against the included bucket. Alternatively, the common environment variables recognized by the `aws` CLI (i.e. `AWS_PROFILE`, `AWS_REGION`, `AWS_SECRET_ACCESS_KEY`, `AWS_ACCESS_KEY_ID`, etc) will be automatically read. +## `filename` + +Defaults to `{timestamp}.{ext}`. + +Coupled with the "location" configuration, a fully templated path will result as +(by default) `backups/{table}/{timestamp}.{ext}`. This yields a new file each +time a command is run. + +```{tip} +`{timestamp}` is a "variable" template source, meaning a new value will be yielded +each time. In order to reference a static filename, configure a filename without +a variable source, e.x. `{table}.{ext}`. +``` + ## `strategy` Defaults to `use_latest_filename`. diff --git a/pyproject.toml b/pyproject.toml index 22c5c52..063e846 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "databudgie" -version = "2.8.4" +version = "2.8.5" packages = [ { include = "databudgie", from = "src" }, ]