workflows: Add github action checking emoji data matching with server.

[Ezio-Sarthak]

The workflow uses CRON time syntax to schedule the check daily at a specific time.
In case of a mismatch in fetched data and existing data, the check would fail with exit status: Emoji data not up-to-date.

[unrelated]: Corrects a couple of diffs :)

Fixes #912

[Abhirup-99]

Wouldn't it be better if it's checked in every push and PR? If something breaks in a certain pr, it would be very difficult to identify it. Also, the main branch is supposed to be stable and we are all using it during development, so this goes against that.

[prah23]

I second @Ezio-Sarthak's approach here. A CRON job might be better suited as these change infrequently as mentioned in the issue. We wouldn't have to run this as frequently as on every push and PR, also considering the frequency of that is highly variable. I presume the check is meant to be more general. Since the emoji list is auto-generated and not meant to be modified manually, the chance of something breaking in a PR should be significantly low.

[Ezio-Sarthak]

@Abhirup-99 I initially had a thought of doing so, but as mentioned by Neil in the issue, this (that is, change in emoji data) should be infrequent, and so a regular check could be enough. Also, since we have some workflows triggering already (specially codeql), having one more with every push would be a bloat to the repo.

@prah23 Thanks for the clarification 👍

PS - The PR is open for reviews :)

[neiljp]

@Ezio-Sarthak Thanks for looking into this 👍

The guts of this check seem good, but I do think we need to think about how the triggering and notification is going to occur.

I'm not sure how feasible it is, but sending the results to a Zulip topic may be the tidiest result here. If I understand the parallels, this is being worked on for zulip/zulip; I just posted in #automated testing>Unicode emoji sync to query this.

Given how minimal this is, we could limit this to trigger only on pushes to main on zulip/zulip-terminal. I'm not sure if we want this to fail CI due to this, but I'm not sure what other notification options we have that are straightforward.

If this runs on a timed schedule, I'm not sure where the result appears?

[neiljp]

Perhaps use --exit-code with git diff, and $? ?

[Ezio-Sarthak]

Thanks. I didn't know it before 😅

[Ezio-Sarthak]

@neiljp Thanks for the review!

The notification of check on czo topic is a pretty awesome idea!
I'll see if I could make a script to send a message to czo #zulip-terminal > Unicode emoji sync with server if that's possible :)
Also, do we have to notify in czo only if there's a change in data?

[neiljp]

From a skim of the secrets documents, we would likely want this to be in an environment variable rather than exposed in clear text.

[Ezio-Sarthak]

As of my knowledge, secrets are default environment variable itself in GitHub actions.
However, It's good storing them as env variables in any case 👍. This will tidy-up the relevant code wherever they are used. (currently double brackets seem visually messy).

[neiljp]

We can easily change these later, but:

• I expect it'd be better to have a more general single topic for CI feedback, since we have everything in one stream.
• Re the content, we may wish to specify more that this originates from a server emoji update.

[Ezio-Sarthak]

• Re topic, maybe something like: "CI action feedback"?
• Re the content, the below message could be a potential description?:
  "Heads up! Emoji sync with the server failed!
  This originated from an update in server emoji. Kindly re-generate unicode_emojis.py"

[zulipbot]

Heads up @Ezio-Sarthak, we just merged some commits that conflict with the changes your made in this pull request! You can review this repository's recent commits to see where the conflicts occur. Please rebase your feature branch against the upstream/main branch and resolve your pull request's merge conflicts accordingly.