Skip to content

Maintainers Guide

This is the start of the maintainers guide for Mealie developers. Those who have been invited to the GitHub organization and/or those who whish to play a bigger part in the Mealie developers community may find this helpful.

Managing Issues

If you are working on issues, it can be helpful to understand the workflow for our repository. When an issue comes in it is tagged with the bug and triage flags. This is to indicate that they need to be reviewed by a maintainer to determine validity.

After you've reviered an issue it will generally move into one of two states:

bug:confirmed
Your were able to verify the issue and we determined we need to fix it
needs more info
The orignal post does not contain enough information, and if the reporter does not provide additional information, the issue will be automatically closed.

Once you've reviewed an issue and moved it into another category, you should remove the triage label.

While going through issues try to keep the following in mind

  • It is perfectly okay to ignore an issue if it is low quality
  • You should close any issues that ignore the standard report template and request they reopen the issue using the proper template
  • You should not try to reproduce issues that don't have clear reproduction steps, don't have a version provided, or are generally unclear.
  • Issues that are not bugs, should likely be converted to discussions.

Drafting Releases

Tags

Mealie is published via GitHub actions to the GitHub container registry with the follow tags:

ghcr.io/mealie-recipes/mealie:nightly
published with every push to mealie-next branch - Actions File
ghcr.io/mealie-recipes/mealie:latest
published when a new GitHub Release is created - Actions File
ghcr.io/mealie-recipes/mealie:{version}
published when a new GitHub Release is created - Actions File

Note

Both the latest, and {version} tags will be the same container on the release of a new version

Process

Because we've built all our publishing effors on GitHub Actions we rely primarily on automations to perform our releases. As such creating a new build of Mealie is as simple as creating a new GitHub release. Here are the general steps we take to create a new release

  1. Navigate to the Github Release Page and click the 'Draft a new release' button.
  2. Choose a tag and increment the version according to the semver specification. i.e, major version for breaking changes, minor for feature updates, and patch for bug fixes.
  3. Name the Release, usually just the tag is fine, however if there is a special feature you'd like to higlight this would be a great place to do it.
  4. Click the "Generate release notes" button which will pull in all the Git Commits as a changelog. For bug fix only releases this is sufficient, however if there are major features, or good quality of life improvements it's good to provide those prior to listing the full changelog.

Tip

Don't worry about setting the version number in the container or code, it's set during the build process and uses the tag you specified when drafting a new release.

You can see how this is done in the Actions File