Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

small upgrades in readme and contributing, fix license check file to … #221

Merged
merged 2 commits into from
Mar 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
### Contributor's Note

<!---
Please mark the following items with an [x] if they apply to your PR.
Leave the [ ] if they are not applicable, or if you have not completed the item.
- [ ] I have added / updated documentation in `/docs` for any user-facing features or additions.
- [ ] I have ran acceptance tests for `Debug` provider to verify that the change works as expected.
- [ ] I have ran acceptance tests for `Google Cloud Storage` provider to verify that the change works as expected.
- [ ] I have ran acceptance tests for `Azure Blob Storage` provider to verify that the change works as expected.
- [ ] I have ran acceptance tests for `AWS S3` provider to verify that the change works as expected.
Leave the [ ] open if they are not applicable, or if you have not completed the item.
--->

- [ ] I have added or updated documentation in `/docs` for any user-facing features or additions.
- [ ] I have ran acceptance tests for `Debug` provider to verify that the change works as expected.
- [ ] I have ran acceptance tests for `Google Cloud Storage` provider to verify that the change works as expected.
- [ ] I have ran acceptance tests for `Azure Blob Storage` provider to verify that the change works as expected.
- [ ] I have ran acceptance tests for `AWS S3` provider to verify that the change works as expected.

<!--- acceptance tests are defined in CONTRIBUTING.md file --->
<!---
acceptance tests are defined in CONTRIBUTING.md file
see https://github.com/rafsaf/backuper/blob/main/CONTRIBUTING.md#acceptance-tests
--->
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,11 +73,11 @@ Note, exactly above is being run inside runners in tests github action.

## Acceptance tests

The tests folder includes tests for cloud providers integrations, but for obvious reasons this cannot replace end-to-end tests with **real** credentials to storage in cloud and eventually costs involved.
The tests folder includes tests for cloud providers integrations, but for obvious reasons this cannot replace end-to-end tests with **real** credentials to storage in cloud and eventually costs involved, proceed with caution!

For `Debug` provider acceptance tests, existing `.env.example` can be ok for `.env` file. To test other providers, you will need to change `BACKUP_PROVIDER` environment variable accordingly.

Then `acceptance_tests_amd64` (or even for arm64 `acceptance_tests_arm64`) will use target `build` and your local `.env` file.
Then `make acceptance_tests_amd64` (or even for arm64 `make acceptance_tests_arm64`) will build docker image target `build` and your local `.env` file, then fire single backup to upload provider and exit.

## Coding conventions

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,13 @@ Everyday 5am backup of PostgreSQL database defined in the same file and running

services:
db:
image: postgres:15
image: postgres:16
environment:
- POSTGRES_PASSWORD=pwd
backuper:
image: rafsaf/backuper:latest
environment:
- POSTGRESQL_PG15=host=db password=pwd cron_rule=0 0 5 * * port=5432
- POSTGRESQL_PG16=host=db password=pwd cron_rule=0 0 5 * * port=5432
- ZIP_ARCHIVE_PASSWORD=change_me
- BACKUP_PROVIDER=name=debug
```
Expand Down
3 changes: 0 additions & 3 deletions backuper/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +0,0 @@
# Copyright: (c) 2024, Rafał Safin <rafal.safin@rafsaf.pl>
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)

3 changes: 0 additions & 3 deletions backuper/backup_targets/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +0,0 @@
# Copyright: (c) 2024, Rafał Safin <rafal.safin@rafsaf.pl>
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)

3 changes: 0 additions & 3 deletions backuper/models/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +0,0 @@
# Copyright: (c) 2024, Rafał Safin <rafal.safin@rafsaf.pl>
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)

3 changes: 0 additions & 3 deletions backuper/notifications/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +0,0 @@
# Copyright: (c) 2024, Rafał Safin <rafal.safin@rafsaf.pl>
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)

3 changes: 0 additions & 3 deletions backuper/tools/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +0,0 @@
# Copyright: (c) 2024, Rafał Safin <rafal.safin@rafsaf.pl>
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)

4 changes: 0 additions & 4 deletions backuper/upload_providers/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +0,0 @@
# Copyright: (c) 2024, Rafał Safin <rafal.safin@rafsaf.pl>
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)


33 changes: 0 additions & 33 deletions scripts/license_check.py

This file was deleted.

3 changes: 0 additions & 3 deletions tests/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +0,0 @@
# Copyright: (c) 2024, Rafał Safin <rafal.safin@rafsaf.pl>
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)