Restructure event directories by kwzrd · Pull Request #129 · python-discord/branding

kwzrd · 2021-03-06T21:52:04Z

Closes #123.
Closes #127.

This PR implements the changes proposed in #123.

The events directory (previously seasonal) is restructured and configured with meta.md files to be used by Python's new branding manager. A validation script is added, which will run in CI and validate event configuration to ensure that a broken setup doesn't reach the main branch.

What has changed?

The changes are not too dramatic - the new events directory is very similar in structure to what we had before. The new addition are meta.md files, which use frontloaded YAML to provide each event with a description and a duration. These files are fetched and read by the Python bot.

The exact structure that events must comply with in order to pass validation is documented in the new events/README.md. I will therefore not go into too much detail, as I assume that reviewers will read the README anyway.

Branding for past one-time events (i.e. jams) is not included in the events directory. I've placed those assets into a parallel jams directory. It is assumed that the branding manager will be used to manage jam assets in the future, but it does not make sense to include past events as they will never be applied again.

Validation & CI

I have added a validation script that lives in the events directory. It's a few lines of code that will run through the directory and verify that each event is correctly set up, and that there are no collisions between events. It depends on the YAML parser declared in the requirements file. The script exits with a non-0 code if it detects errors.

I have also added a GH Actions workflow that runs this script on pull requests and new commits on main. However, it seems that since I am working from a fork, we will not be able to run the workflow until the PR is merged into the upstream. Reviewers can run the script locally (see the events README for instructions). I have tested and verified that it fails the workflow if errors are found.

PyDis projects use a custom workflow for sending status embeds to the #mod-log channel, reporting whether CI passed. Because I have struggled a little bit with understanding how this workflow works, and didn't want to blindly copy-paste it without being able to test, I'd prefer for it to be added later (directly in upstream, and probably by someone more experienced). So for now the CI runs and validates events, but does not produce a cute status embed.

Assets

This PR adds an Easter banner, which was previously missing. It is a simple colour edit of the evergreen SVG:

Event descriptions

With the help of @dawnofmidnight we have added a short description for each event. The descriptions are pulled by Python and presented as embeds:

Each description links Wikipedia or similar for more information. I assume there may be some discussion regarding the descriptions. I wasn't entirely sure on how to approach them.

Calendar

Quick overview of current configuration, formatted as event_name[start_day-end_day]. Both bounds inclusive.

February: Valentines[1-15], BHM[16-29]
March: StPatrick[10-18]
April: Easter[1-30]
June: Pride[1-30]
October: Hacktoberfest[1-31]
November: Diwali[1-7]
December: Christmas[1-25], NewYear[26-31]

Python-side, a calendar overview can be produced on-demand from the fetched events:

I'd recommend that reviewers also read the Python-side PR description.

Move all files from the 'seasonal' directory into 'events' and adjust internal event structure for the new schema. A new directory 'jams' contains jam-related assets. These may eventually live in 'events' as well, but since the event-calender is not officially decided yet, I decided to keep them separately. All files removed by this commit were duplicates.

For now, the files contain the start and end dates, and a header. Descriptions will be added later. The Evergreen season is a special case, registering as a 'fallback', rather than having a defined period. This is the branding that we use when no other event is active. By default, we understand the 'fallback' key to be False.

This also adds a 'meta.md' for the new event.

Use the evergreen logo SVG edited to use colours of the Easter logo.

kwzrd · 2021-03-16T22:27:02Z

This PR will now also add the missing Easter banner (#127). It's a colour edit of the evergreen one to match the Easter logo:

PR includes both the SVG base & a rendered PNG.

Many of these were contributed by DawnOfMidnight! Co-authored-by: DawnOfMidnight <78233879+dawnofmidnight@users.noreply.github.com>

kwzrd · 2021-03-28T11:15:47Z

🙏

Ready for review!

lemonsaurus

This looks excellent to me. Very well done.

Shivansh-007

Looks good! Just 2 grammar changes (can be ignored) and it would be perfect!

Shivansh-007 · 2021-03-29T06:57:58Z

+
+## Automatic validation
+
+Fortunately, it is not necessarily to manually verify that all events are configured properly w.r.t. the requirements explained above. The `validation.py` script contains logic to ascertain correct setup, and will automatically run in CI on pull requests to prevent a broken configuration from reaching the production branch.


Suggested change

Fortunately, it is not necessarily to manually verify that all events are configured properly w.r.t. the requirements explained above. The `validation.py` script contains logic to ascertain correct setup, and will automatically run in CI on pull requests to prevent a broken configuration from reaching the production branch.

Fortunately, it is not necessary to manually verify that all events are configured properly w.r.t. the requirements explained above. The `validation.py` script contains logic to ascertain correct setup, and will automatically run in CI on pull requests to prevent a broken configuration from reaching the production branch.

Shivansh-007 · 2021-03-29T06:59:05Z

+
+The markdown section of the meta file then contains the event's description. Descriptions are made available directly in the Discord guild as embeds sent by the Python bot. For formatting, use Discord's watered down Markdown ~ keep in mind that e.g. the `#` symbol does not create a heading.
+
+A description is required to exist, and must be at most 2048 characters in length in order to fit into a Discord embed. 


Suggested change

A description is required to exist, and must be at most 2048 characters in length in order to fit into a Discord embed.

A description is required to exist, and must be at most 2048 characters in length to fit into a Discord embed.

Shivansh-007 · 2021-03-29T07:01:37Z

+
+## Event directory structure
+
+In order for an event directory to be valid, it has to contain the following assets.


Suggested change

In order for an event directory to be valid, it has to contain the following assets.

For an event directory to be valid, it has to contain the following assets.

in order for seems a bit wordy here, it is grammatically correct, but keeping it concise is better.

Co-authored-by: Shivansh-007 <Shivansh-007@users.noreply.github.com>

kwzrd · 2021-03-29T11:14:46Z

@lemonsaurus Thank you for the review!

@Shivansh-007 Thanks, applied in f8c4282.

Shivansh-007

lemonsaurus

Let's do this.

kwzrd added 3 commits March 6, 2021 15:33

Git: add '.idea' to ignores

29388f8

kwzrd marked this pull request as draft March 6, 2021 21:52

kwzrd mentioned this pull request Mar 13, 2021

Rewrite branding manager python-discord/bot#1463

Merged

6 tasks

Base automatically changed from master to main March 13, 2021 19:17

kwzrd added 3 commits March 15, 2021 15:26

Events: add 'requirements.txt' with validation deps

db18060

Events: add validation script

ab6f1b3

CI: add event validation workflow

ef1d1a9

kwzrd marked this pull request as ready for review March 15, 2021 19:27

kwzrd added 5 commits March 15, 2021 20:50

Merge: Diwali event assets from 'upstream/main'

8d251cc

This also adds a 'meta.md' for the new event.

CI: improve step name

3822c94

Events: update README to document new structure

fead2b6

Events: add note on Pipenv installation to README

4ab143e

Events: add Easter banner asset

7e8b442

Use the evergreen logo SVG edited to use colours of the Easter logo.

kwzrd mentioned this pull request Mar 16, 2021

Create Easter themed banner #127

Closed

kwzrd marked this pull request as draft March 18, 2021 08:36

kwzrd mentioned this pull request Mar 26, 2021

Add New Year banner #140

Merged

kwzrd and others added 3 commits March 27, 2021 17:46

Events: populate descriptions in 'meta.md' files

9392348

Many of these were contributed by DawnOfMidnight! Co-authored-by: DawnOfMidnight <78233879+dawnofmidnight@users.noreply.github.com>

Merge: New Year banner asset from 'upstream/main'

0459f18

Events: move New Year banner SVG into 'assets'

2a2ab5a

kwzrd marked this pull request as ready for review March 28, 2021 11:14

lemonsaurus previously approved these changes Mar 29, 2021

View reviewed changes

Shivansh-007 previously approved these changes Mar 29, 2021

View reviewed changes

kwzrd and others added 2 commits March 29, 2021 13:10

Events: improve grammar & docstring style

f8c4282

Co-authored-by: Shivansh-007 <Shivansh-007@users.noreply.github.com>

Git: add 'Pipfile*' to ignores

04099d2

kwzrd dismissed stale reviews from Shivansh-007 and lemonsaurus via 04099d2 March 29, 2021 11:13

Shivansh-007 approved these changes Mar 29, 2021

View reviewed changes

lemonsaurus approved these changes Mar 29, 2021

View reviewed changes

lemonsaurus merged commit 6e6f2ad into python-discord:main Mar 29, 2021

kwzrd mentioned this pull request Mar 30, 2021

Add embed status workflow #143

Closed

kwzrd mentioned this pull request Apr 22, 2021

Create New Year's themed banner #128

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Restructure event directories#129

Restructure event directories#129
lemonsaurus merged 16 commits into
python-discord:mainfrom
kwzrd:kwzrd/events-rework

kwzrd commented Mar 6, 2021 •

edited

Loading

Uh oh!

kwzrd commented Mar 16, 2021

Uh oh!

kwzrd commented Mar 28, 2021

Uh oh!

lemonsaurus left a comment

Uh oh!

Shivansh-007 left a comment

Uh oh!

Shivansh-007 Mar 29, 2021

Uh oh!

Shivansh-007 Mar 29, 2021

Uh oh!

Shivansh-007 Mar 29, 2021

Uh oh!

kwzrd commented Mar 29, 2021

Uh oh!

Shivansh-007 left a comment •

edited

Loading

Uh oh!

lemonsaurus left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants


		## Automatic validation

		Fortunately, it is not necessarily to manually verify that all events are configured properly w.r.t. the requirements explained above. The `validation.py` script contains logic to ascertain correct setup, and will automatically run in CI on pull requests to prevent a broken configuration from reaching the production branch.

	Fortunately, it is not necessarily to manually verify that all events are configured properly w.r.t. the requirements explained above. The `validation.py` script contains logic to ascertain correct setup, and will automatically run in CI on pull requests to prevent a broken configuration from reaching the production branch.
	Fortunately, it is not necessary to manually verify that all events are configured properly w.r.t. the requirements explained above. The `validation.py` script contains logic to ascertain correct setup, and will automatically run in CI on pull requests to prevent a broken configuration from reaching the production branch.


		The markdown section of the meta file then contains the event's description. Descriptions are made available directly in the Discord guild as embeds sent by the Python bot. For formatting, use Discord's watered down Markdown ~ keep in mind that e.g. the `#` symbol does not create a heading.

		A description is required to exist, and must be at most 2048 characters in length in order to fit into a Discord embed.


		## Event directory structure

		In order for an event directory to be valid, it has to contain the following assets.

	In order for an event directory to be valid, it has to contain the following assets.
	For an event directory to be valid, it has to contain the following assets.

Uh oh!

Conversation

kwzrd commented Mar 6, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What has changed?

Validation & CI

Assets

Event descriptions

Calendar

Uh oh!

kwzrd commented Mar 16, 2021

Uh oh!

kwzrd commented Mar 28, 2021

Uh oh!

lemonsaurus left a comment

Choose a reason for hiding this comment

Uh oh!

Shivansh-007 left a comment

Choose a reason for hiding this comment

Uh oh!

Shivansh-007 Mar 29, 2021

Choose a reason for hiding this comment

Uh oh!

Shivansh-007 Mar 29, 2021

Choose a reason for hiding this comment

Uh oh!

Shivansh-007 Mar 29, 2021

Choose a reason for hiding this comment

Uh oh!

kwzrd commented Mar 29, 2021

Uh oh!

Shivansh-007 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lemonsaurus left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

kwzrd commented Mar 6, 2021 •

edited

Loading

Shivansh-007 left a comment •

edited

Loading