Skip to content

Development Notes#

Here are some notes on the development of the project.

media.ccc.de API#

For implementing the search, the api https://api.media.ccc.de/public/events/search?q=<SEARCH>will be used.

You can find the "full" api documentation here: https://github.com/voc/voctoweb?tab=readme-ov-file#public-json-api

Wording#

Sometimes, the word "event" is used to refer to a talk. This is because the API from media.ccc.de is using the term "event", while I prefer to use "Talk".

"Branding"#

Our main colors are:

  • Main: #9b69ff
  • Secondary: #5710e6

Why are there so many CI fix commits?#

Most of them are due to the fact that I am a bit new to Playwright (E2E-Testing) and also probably because I am doing things more complicated than they have to be.

Getting the minimum engine version#

npx ls-engines --mode actual --save

Using the actions/labeler action#

The actions/labeler action is used to automatically add labels to pull requests. The configuration is stored in .github/labeler.yml.

You can find the documentation here: actions/labeler

Creating a release#

Run the following command:

yarn version --minor # or --patch or --major

This will then create a commit "Publish Talkarr vX.Y.Z" and a tag "vX.Y.Z". These can be pushed to the remote repository with:

git push --follow-tags

After the CI finishes, a new release will be created automatically. It will not be published automatically, but set to "draft" so that you can check it.

Link for quick access to releases

After that, you can just publish it and that's it.

Checking actions for security issues#

There is a tool called zizmor that can be used to check the actions used in the repository for known security issues.