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

Improved Messaging #332

Merged
merged 27 commits into from
Dec 9, 2024
Merged

Improved Messaging #332

merged 27 commits into from
Dec 9, 2024

Conversation

GrantBirki
Copy link
Member

@GrantBirki GrantBirki commented Dec 6, 2024

This pull request greatly improves the messaging system of this Action which is ultimately the text that humans read on PRs that they deploy.

The primary changes are as follows:

  • Several new variables added to the custom deployment message template:
    • sha - The sha of the deployment (String)
    • review_decision - The review status of the pull request (String or null) - Ex: APPROVED, REVIEW_REQUIRED, CHANGES_REQUESTED, null etc.
    • deployment_id - The ID of the deployment (Int or null in the case of .noop deployments)
    • fork - Whether or not the repository is a fork (Boolean)
    • params - The raw string of deployment parameters (String)
    • parsed_params - A string representation of the parsed deployment parameters (String)
    • deployment_end_time - The time the deployment ended - this value is not exact but it is very close (String) ISO 8601 UTC format
    • logs - The URL to the logs of the deployment (String)
  • Updated pre-deploy messages
  • Updated post-deploy message
  • Improved logging
  • Improved unit tests
  • Refactoring of post deployment messages logic

Updated Pre Deploy Messages

Pre-deploy (initial kick-off messages) will now have a Details section that is expandable and contains rich data about the deployment that is soon to be created. Example:

Screenshot 2024-12-08 at 10 07 58 PM

Updated Post Deploy Messages

Post-deploy messages will also have a new Details section that is expandable and contains rich data about the deployment that has just completed.

Screenshot 2024-12-08 at 10 08 41 PM

@GrantBirki
Copy link
Member Author

Testing this out so far and the deployment messages (a custom one) has a lot more details:

Screenshot 2024-12-06 at 3 33 07 PM

@GrantBirki GrantBirki marked this pull request as ready for review December 9, 2024 05:52
@GrantBirki GrantBirki added the enhancement New feature or request label Dec 9, 2024
@GrantBirki GrantBirki self-assigned this Dec 9, 2024
@GrantBirki GrantBirki merged commit 691e5df into main Dec 9, 2024
4 checks passed
@GrantBirki GrantBirki deleted the improved-messaging branch December 9, 2024 06:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant