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

fix: Add required format field to rich text date blocks #1317

Merged

Conversation

luke-josh
Copy link
Contributor

@luke-josh luke-josh commented Aug 26, 2024

As per block kit docs, the date element requires a format string to be included. Currently, submitting a block kit with this element results in a slack API error.

Also added the two optional fields url and fallback for posterity.

PR preparation

Run make pr-prep from the root of the repository to run formatting, linting and tests.

Should this be an issue instead
  • is it a convenience method? (no new functionality, streamlines some use case)
  • exposes a previously private type, const, method, etc.
  • is it application specific (caching, retry logic, rate limiting, etc)
  • is it performance related.
API changes

Since API changes have to be maintained they undergo a more detailed review and are more likely to require changes.

  • no tests, if you're adding to the API include at least a single test of the happy case.
  • If you can accomplish your goal without changing the API, then do so.
  • dependency changes. updates are okay. adding/removing need justification.
Examples of API changes that do not meet guidelines:
  • in library cache for users. caches are use case specific.
  • Convenience methods for Sending Messages, update, post, ephemeral, etc. consider opening an issue instead.

@luke-josh luke-josh changed the title Add required format field to rich text date blocks Add required format field to rich text date blocks Aug 26, 2024
@luke-josh luke-josh force-pushed the luke-josh/rich-text-date-block-patch branch from b4c99e5 to e5c672a Compare August 26, 2024 23:24
@lorenzoaiello lorenzoaiello changed the title Add required format field to rich text date blocks fix: Add required format field to rich text date blocks Sep 17, 2024
Copy link
Contributor

@lorenzoaiello lorenzoaiello left a comment

Choose a reason for hiding this comment

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

Apologies for the delay, and thank you for your contribution!

This pull request fixes rich text date blocks by including the format field as documented in the public block kit documentation. Additionally, it adds the ability to set the url and fallback fields which are also publicly documented.

Note: This does include breaking changes to the NewRichTextSectionDateElement function.

@lorenzoaiello lorenzoaiello merged commit cd4e26e into slack-go:master Sep 17, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants