Skip to content

Commit f20fa66

Browse files
committed
docs: add notable changes and details from rc.3
1 parent 12a9e38 commit f20fa66

File tree

1 file changed

+32
-2
lines changed

1 file changed

+32
-2
lines changed

docs/Upgrading to v2.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This guide attempts to cover everything needed for a seamless upgrade from GitPr
44

55
Most errors will be related to invalid database records added in v1 - mainly in the `user` and `repo` databases. As of writing, database migration files are not provided.
66

7-
## Noteworthy changes and their consequences
7+
## Breaking changes
88

99
Two important breaking changes were made:
1010

@@ -24,7 +24,7 @@ However, as URL parsing is more strict, pushing to previously added GitHub repos
2424

2525
## Troubleshooting typical errors
2626

27-
Most of these errors can be easily **fixed by simply accessing the UI** to delete the offending repository, add it again, and restore all the allowed users. Manually editing the database entries is not recommended, but nevertheless a valid solution.
27+
Most of these errors can be easily **fixed by simply accessing the UI** to delete the offending repository, add it again, and restore all the allowed users. Manually editing the database entries is not recommended, but also works.
2828

2929
If you encounter any errors not on this guide, feel free to [open a discussion](https://github.com/finos/git-proxy/discussions).
3030

@@ -83,3 +83,33 @@ User data:
8383
```
8484

8585
This is easily **solved by removing and re-adding the users from the dropdown list** in the UI (in the repository details page).
86+
87+
## Other notable changes
88+
89+
### Features
90+
91+
- Added the ability to create new users via the GitProxy CLI in [#981](https://github.com/finos/git-proxy/pull/981)
92+
- Added `/healthcheck` endpoint for AWS Load Balancer support [#1197](https://github.com/finos/git-proxy/pull/1197)
93+
94+
### Bugfixes
95+
96+
- Fixed `--force` pushes failing due to the `getDiff` action blocking legitimate empty diffs in [#1182](https://github.com/finos/git-proxy/pull/1182)
97+
- Fixed incorrect error message on cloning unauthorized repos in [#1204](https://github.com/finos/git-proxy/pull/1204)
98+
- Caused by improper Git protocol error handling for `GET /info/refs` requests, resulting in Git client receiving malformed `upload-pack` data
99+
- Fixed duplicated chain execution when pushing a PR that has been approved in [#1209](https://github.com/finos/git-proxy/pull/1209)
100+
- Caused by an issue with raw body extraction on `POST git-pack` requests
101+
- Reimplemented push parsing to fix various issues related to packfile decoding in [#1187](https://github.com/finos/git-proxy/pull/1187)
102+
- Fixed `Z_DATA_ERROR` when pushing
103+
- Fixed Git object header parsing and packfile metadata reading
104+
- Reimplemented decompression to better replicate how Git handles it (replaced inflating/deflating the object)
105+
- Fixed logout failure in production caused by UI defaulting to `http://localhost:3000` when `VITE_API_URI` is unset in [#1201](https://github.com/finos/git-proxy/pull/1201)
106+
- Refactors API URL usages to rely on a single source of truth, sets default values
107+
- Fixed a potential denial-of-service vulnerability when pushing to an unknown repository in [#1095](https://github.com/finos/git-proxy/pull/1095)
108+
- Caused by a bug in the MongoDB implementation `isUserPushAllowed` which assumed that the repository exists. If the repository wasn't found, the backend crash when attempting to access its properties
109+
- Fixed `MongoServerError` when updating user due to attempting to override the pre-existent `_id` in [#1230](https://github.com/finos/git-proxy/pull/1230)
110+
111+
### Other improvements
112+
113+
- Optimized push speed by performing shallow clones by default in [#1189](https://github.com/finos/git-proxy/pull/1189)
114+
- Increased push speeds for larger repos [by around 30~50%](https://github.com/finos/git-proxy/issues/985)
115+
- Improved configuration validation and typing in [#1140](https://github.com/finos/git-proxy/pull/1140)

0 commit comments

Comments
 (0)