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

docs: clean up s3 examples #701

Merged
merged 1 commit into from
Jan 26, 2024
Merged

docs: clean up s3 examples #701

merged 1 commit into from
Jan 26, 2024

Conversation

ricellis
Copy link
Member

Checklist

  • Added tests for code changes or test/build only changes
  • Updated the change log file (CHANGES.md) or test/build only changes
  • Completed the PR template below:

Description

Clean up the S3 example scripts.

Fixes #694

Approach

  • Extende the examples/README.md with additional instructions and details.
  • Clean up dependencies
    • Add dependency on latest 2.x @cloudant/couchbackup (docs said it was using the repo version, but the code had been changed when the package became scoped that it wasn't actually using the checked out version - better to just use latest compatibile shipped version).
    • Use latest modular v3 aws-sdk for client-s3, credential-providers, lib-storage
    • Remove dependency on tmp
    • Remove unusued dev-dependencies
  • Clean up package.json to update version to 0.0.2 and remove unused script command.
  • Update script code for latest aws-sdk changes.
  • Add couchbackup event handlers for additional progress/debug.

Schema & API Changes

  • "No change"

Security and Privacy

  • "No change"

Testing

  • N/A example code, but I tested it manually.

Monitoring and Logging

  • "No change"

@ricellis ricellis marked this pull request as ready for review January 26, 2024 12:33
Copy link
Member

@eiri eiri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typos, but overall lgtm

examples/README.md Outdated Show resolved Hide resolved
examples/README.md Outdated Show resolved Hide resolved
examples/README.md Outdated Show resolved Hide resolved
@ricellis ricellis merged commit 9660717 into main Jan 26, 2024
4 checks passed
@ricellis ricellis deleted the 694-s3-example branch January 26, 2024 16:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

s3 backup script does not work
3 participants