Skip to content

Commit

Permalink
[hma] Update CONTRIBUTING.md to include release instructions (#1631)
Browse files Browse the repository at this point in the history
Add release instructions to contributing doc to explain how to release a new version of the project
  • Loading branch information
juanmrad authored Oct 1, 2024
1 parent 1662302 commit b05e8fc
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions hasher-matcher-actioner/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,33 @@ Open Media Match is written in Python, uses [Flask](https://flask.palletsproject

Please see CONTRIBUTING in the repo root for more general guidelines on how to contribute by developing locally and submitting pull requests on GitHub.

# Releasing a New Version

To release a new version of the Open Media Match image, follow these steps:

1. **Update the version.txt file**

The version number is stored in the `version.txt` file located at the project subfolder. Modify this file to reflect the new version number (e.g., `v1.1.0`).

```bash
echo "v1.1.0" > version.txt
```

2. **Merge to main**
Once the `version.txt` file is updated, and merged to main a new build will be triggered automatically via the CI/CD pipeline. This will create a new Docker image with the updated version and be pushed to the registry.

3. **Verify the Build and Release**
Monitor the build process to ensure everything runs smoothly. Once the build completes, the new Docker image will be tagged with the updated version and pushed to the registry.

4. **Test the New Image**
After the new image is successfully built and tagged, it can be tested locally by using the tagged image or deployed to your environment. This process may vary depending on your deployment setup (e.g., Kubernetes, Docker Swarm, etc.).

**Notes:**
- Do the version increase on its own PR to separate version releases from code changes.
- Ensure any expected changes in the codebase are included in the release, and all tests are passing before modifying the `version.txt` file.
- For breaking changes, consider incrementing the major version number (e.g., `v2.0.0`).


# Developer onboarding and environment setup

There are a few different ways you can set up a development instance of Open Media Match and get to work.
Expand Down

0 comments on commit b05e8fc

Please sign in to comment.