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

Remove SENTRY_DSN from required env vars #585

Merged
merged 1 commit into from
Dec 13, 2024
Merged

Conversation

ghukill
Copy link
Contributor

@ghukill ghukill commented Dec 12, 2024

Purpose and background context

For local development, or external users of this application, it does not make sense to require a SENTRY_DSN environment variable. While setting this to 'none' would satisfy the config setup, and not use Sentry, it feels unnecessary.

How this addresses that need:

  • Moves SENTRY_DSN to optional env vars in Config class

NOTE: this PR ports the code changes from another PR #584 (thanks @cjwetherington!), which we were unable to merge at the time for unrelated CI/CD reasons.

How can a reviewer manually see the effects of these changes?

1- unset SENTRY_DSN as environment variable

2- The following should show CLI help, where formerly this would throw a required env var error:

pipenv run oai --verbose \
-o /tmp/test.xml \
-h http://example.com \
harvest --help

Includes new or updated dependencies?

NO

Changes expectations for external applications?

NO: SENTRY_DSN is no longer required as an env var, but providing it will still get picked up used

What are the relevant tickets?

  • None

Developer

  • All new ENV is documented in README
  • All new ENV has been added to staging and production environments
  • All related Jira tickets are linked in commit message(s)
  • Stakeholder approval has been confirmed (or is not needed)

Code Reviewer(s)

  • The commit message is clear and follows our guidelines (not just this PR message)
  • There are appropriate tests covering any new functionality
  • The provided documentation is sufficient for understanding any new functionality introduced
  • Any manual tests have been performed or provided examples verified
  • New dependencies are appropriate or there were no changes

Why these changes are being introduced:

For local development, or external users of this application, it does not make sense
to require a SENTRY_DSN environment variable.  While setting this to 'none' would
satisfy the config setup, and not use Sentry, it feels unnecessary.

How this addresses that need:
* Moves SENTRY_DSN to optional env vars in Config class

Side effects of this change:
* SENTRY_DSN is no longer required as an env var, but providing it will still get
picked up used

Relevant ticket(s):
* None
@ghukill ghukill merged commit 347de17 into main Dec 13, 2024
4 checks passed
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.

3 participants