ENG-5982 fix: increase timeout for httpx client to 30s + added logging #26
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://linear.app/novi/issue/ENG-5982/release-helper-not-working-as-expected
Summary:
This PR addresses the issue described in ticket "Release helper not working as expected". The problem involved the GitHub Action not posting updates in the #production-deploys Slack channel and failing to trigger a release, despite no visible failures during the action's execution.
Changes Implemented:
Updated the README.md file to include detailed setup instructions. This will help developers easily configure the project and avoid any setup-related issues.
Introduced a new task in taskfile.sh to run docker compose up, enabling developers to build and run the container more efficiently.
The HTTPX client timeout has been increased from the default 5 seconds to 30 seconds. This change ensures that the client has enough time to complete requests, particularly in slower network conditions, which may have been causing the release helper to fail silently.
Increased the verbosity of logging for GitHub Actions stdout. This enhancement will make it easier to trace the output and identify potential issues more quickly if something goes wrong during the release process.
Additional logging has been implemented around Slack message postings. This will provide more visibility into the process and help in diagnosing issues if messages fail to post in the #production-deploys channel.
Impact:
These changes aim to resolve the issue where the release helper was not working as expected, particularly in ensuring that releases are correctly kicked off and notifications are posted to the appropriate Slack channel. The improved setup instructions and logging will also aid in easier setup and troubleshooting in the future.