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

Suggestions: Improve display of webhook #27

Open
Andre601 opened this issue Aug 31, 2020 · 0 comments · May be fixed by #138
Open

Suggestions: Improve display of webhook #27

Andre601 opened this issue Aug 31, 2020 · 0 comments · May be fixed by #138

Comments

@Andre601
Copy link

Andre601 commented Aug 31, 2020

I have a few suggestions to improve the overall display of the Discord Webhook which I list below

Link to a GitHub commit when available.

Right now are GitHub commits displayed like this:

- `abc1234` *GitHub Commit message - user*

While this isn't bad at all, does it miss out on a oportunity, to actually link to a GitHub Commit.
My suggestion is to link to the Commit itself.

- [`abc1234`](https://github.com/MyName/MyRepo/commit/abc1234{sha}) *GitHub Commit message - user*

Add option to use embedded links for Artifact jar.

Right now does the webhook display artifacts like this:

**Artifacts:**
- https://ci.example.com/job/MyJob/1/artifact/path/Artifact.jar

This can look horrible, if the link is quite long.
I suggest to add an option to have the link embedded like this:

**Artifacts:**
- [Artifact.jar](https://ci.example.com/job/MyJob/1/artifact/path/Artifact.jar)

Use actual embed fields instead of Description.

I personally think it would be better to have the different parts (changes and artifacts) in separate fields.
Downside would be a lower text length (Only 1000 characters) but this could be bypassed by having a new field with a zero-width space as title (\u200E) which is supported by Discord.

The biggest downside will be the total character length of 6000 characters per webhook, but this would also be an issue with just using the description, which limits the text to 2000 characters anyway.


I made a very basic example using Leovoel's Embed Visualizer
image

@solonovamax solonovamax linked a pull request Oct 20, 2024 that will close this issue
6 tasks
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 a pull request may close this issue.

1 participant