Skip to content

Commit

Permalink
docs: Add releasing guide and new language note
Browse files Browse the repository at this point in the history
Also removes permalink check
  • Loading branch information
JadedBlueEyes committed Aug 29, 2024
1 parent 95eb4d3 commit 73b08be
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 1 deletion.
1 change: 0 additions & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ repos:
- id: end-of-file-fixer
exclude: fixtures
- id: mixed-line-ending
- id: check-vcs-permalinks
- id: check-merge-conflict
- id: check-added-large-files
# - id: no-commit-to-branch
Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,6 @@ instance. Join in and help translate for your language!
</a>

[![Translation status](https://translations.metabrainz.org/widget/email/email-templates/multi-auto.svg)](https://translations.metabrainz.org/engage/email/)

When adding a new language, please make sure to add the language
to the [list of supported languages](https://github.com/metabrainz/mb-mail-service/blob/main/Cargo.toml#L10).
7 changes: 7 additions & 0 deletions docs/RELEASING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Releasing

1. Update the version in `Cargo.toml` (and update `Cargo.lock`, `cargo` will do
this for you).
2. Tag and push the commit with the new version number. For example, `v0.3.4`
3. Wait for the CI to complete. This will build Docker images and publish
them to Docker Hub with the correct tags.

0 comments on commit 73b08be

Please sign in to comment.