Skip to content

Commit da2f363

Browse files
oops, meant this
2 parents 6fca1c0 + dcd4f25 commit da2f363

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+2196
-531
lines changed

ADOPTERS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ We're proud to be used by the most innovative teams around the world! If you're
1717
| [BforeAI](https://bfore.ai) | [User Story](https://metalbear.com/mirrord/stories/bfore-ai/) |
1818
| [Utila](https://utila.io) | [User Story](https://metalbear.com/mirrord/stories/utila/) |
1919
| [Savvy Security](https://www.savvy.security) | [User Story](https://metalbear.com/mirrord/stories/savvy/) |
20+
| [HM Courts & Tribunal Service](https://www.gov.uk/government/organisations/hm-courts-and-tribunals-service) | [Use Case](https://github.com/hmcts/civil-citizen-ui/blob/master/README.md#development--debugging-environment---preview-with-mirrord) |
2021

2122
\* Optional: link to a blog post, tweet, internal write-up, or leave blank.
2223

CHANGELOG.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,70 @@ This project uses [*towncrier*](https://towncrier.readthedocs.io/) and the chang
88

99
<!-- towncrier release notes start -->
1010

11+
## [3.174.0](https://github.com/metalbear-co/mirrord/tree/3.174.0) - 2025-11-20
12+
13+
14+
### Added
15+
16+
- Added HM Courts & Tribunal Service to ADOPTERS.md.
17+
- Added a new option under `mirrord ci start` to run the binary and wait for it
18+
to complete.
19+
20+
21+
### Changed
22+
23+
- Allow an overlap in the configuration for `incoming.ports` and
24+
`incoming.http_filter.ports`.
25+
26+
27+
### Fixed
28+
29+
- Fixed minor edge case where intproxy might hit code that's supposed to be
30+
unreachable and panic
31+
[#intproxy-panic](https://github.com/metalbear-co/mirrord/issues/intproxy-panic)
32+
- Fixed a DNS regression that happens when user's DNS library bind their
33+
outgoing
34+
socket to unspecified address before send UDP message to the nameserver.
35+
36+
## [3.173.2](https://github.com/metalbear-co/mirrord/tree/3.173.2) - 2025-11-18
37+
38+
39+
### Changed
40+
41+
- Exclude `GOPATH` and `GOMODCACHE` from env fetched
42+
43+
## [3.173.1](https://github.com/metalbear-co/mirrord/tree/3.173.1) - 2025-11-16
44+
45+
46+
### Internal
47+
48+
- Add cleanup of unnecessary items in CI builder for docker builds.
49+
[#add-cleanup-before-docker-build](https://github.com/metalbear-co/mirrord/issues/add-cleanup-before-docker-build)
50+
51+
## [3.173.0](https://github.com/metalbear-co/mirrord/tree/3.173.0) - 2025-11-16
52+
53+
54+
### Changed
55+
56+
- Update `experimental.non_blocking_tcp_connect` config default to `false`.
57+
58+
59+
### Fixed
60+
61+
- Fixed the security advisories of the config's template engine by updating it
62+
to the newest version
63+
[#3657](https://github.com/metalbear-co/mirrord/issues/3657)
64+
65+
66+
### Internal
67+
68+
- Fix the way release script gets workspace version.
69+
- Kubernetes-related packages have been removed from the devshell, they should
70+
be installed system-wide instead.
71+
- Use the pip from the setup action, not the one preinstalled on the runner.
72+
- make CI workflow trigger for PRs targeted to `windows-support` branch
73+
(windows main)
74+
1175
## [3.172.0](https://github.com/metalbear-co/mirrord/tree/3.172.0) - 2025-11-06
1276

1377

CONTRIBUTING.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Make sure to take a look at the project's [style guide](STYLE.md).
1717
- [Adding new target types](#adding-new-target-types)
1818
- [Testing the release workflow](#testing-the-release-workflow)
1919
- [Architecture](#architecture)
20+
- [Release mirrord](#release-mirrord)
2021

2122
# Getting Started
2223

@@ -660,7 +661,7 @@ Add a changelog file in `changelog.d/` named `<identifier>.<category>.md`
660661
**Category:**
661662
Check `towncrier.toml` for available categories (`added`, `changed`, `fixed`, etc.) and choose the one that fits your change.
662663
663-
## Architecture
664+
# Architecture
664665
665666
A high level view of mirrord.
666667
@@ -755,3 +756,27 @@ flowchart TB
755756
style Pod fill:#e6ffe6,stroke:#006600,stroke-width:2px
756757
style Binary fill:#f9f9f9,stroke:#333,stroke-width:2px
757758
```
759+
760+
# Release mirrord
761+
762+
## Release PR
763+
764+
1. Create a new branch named after the new version, e.g. `3.333.0`. This will trigger additional CI jobs.
765+
2. On the new branch, bump the workspace version in `Cargo.toml` and run `cargo update -w` to update `Cargo.lock`.
766+
3. Generate the changelog with: `towncrier build --version <new-version>`.
767+
4. Review the generated changelog and fix any issues or typos.
768+
5. Push the release branch and open a PR.
769+
770+
**Note:** All the steps above can also be completed by running: `./scripts/release.sh 3.333.0`.
771+
Before running the script, ensure there are no uncommitted changes in your repository.
772+
773+
## Create a new GitHub release
774+
775+
1. After the release PR is merged, create a new GitHub release with a new tag. Use the new version for both
776+
the tag name and the release title. Use the changelog from the release PR as the release description,
777+
excluding the `Internal` section if present.
778+
779+
**Note**: Ensure the tag is attached to the release commit.
780+
781+
2. Creating the release will trigger the `Release` workflow, which builds and publishes all artifacts, including images.
782+
3. When the `Release` workflow completes successfully, update the relevant environment variables in the analytics server.

0 commit comments

Comments
 (0)