Git-Mirrors/veilid
1
0
Fork 0
mirror of https://gitlab.com/veilid/veilid.git synced 2025-08-02 11:46:07 -04:00
Code Issues Projects Releases Packages Wiki Activity

Changelog and releasing readme updates

Browse source
This commit is contained in:
TC Johnson 2025-06-03 10:15:13 -05:00
parent b6101382e5
commit cd71551f87
No known key found for this signature in database
2 changed files with 12 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG.md
View file

@ -1,4 +1,4 @@
**UNRELEASED**
**Changed in Veilid 0.4.7**
- _BREAKING API CHANGES_:
- Improve type-safety by splitting out type aliases for `FourCC` and `CryptoKey` types into distinct "newtypes". Previously all instances of these types we just type aliases, and could be used interchangably when in reality they aren't interchangable. This prevents developers from accidentally passing the wrong type into the API, such as a `SecretKey` when you meant to pass a `PublicKey`. Function signatures have been updated to use the correct types, so code will need to be updated accordingly.

17
RELEASING.md
View file

@ -2,7 +2,7 @@
## Introduction
This guide outlines the process for releasing a new version of Veilid. The end result is an update of the package repositories and Pypi.
This guide outlines the process for releasing a new version of Veilid. The end result is an update of the Deb/RPM package repositories, Crates.io, and Pypi.
## Create a Gitlab Release
@ -10,7 +10,7 @@ Releases happen via a CI/CD pipeline. The release process flows as follows:
1. Complete outstanding merge requests (MR):
1.1 Evaluate the MR's adherence to the published requirements and if automatic tests passed.
1.1 Evaluate the MR's adherence to the published requirements and if tests pass.
1.2 (Optional) Perform the merge in a local dev environment if testing is required beyond the standard Earthly tests.
@ -34,19 +34,21 @@ Releases happen via a CI/CD pipeline. The release process flows as follows:
2.8 Push your local the tagged code to trigger the release pipeline `git push -o ci.skip && git push --tags`
2.9 Ensure the package/release/distribute pipeline autostarted in the Gitlab UI
2.9 Ensure the package/release/distribute pipeline autostarts in the Gitlab UI and monitor for failures
Git tags serve as a historical record of what repo versions were successfully released at which version numbers.
Git tags serve as a historical record of what repo versions were released at which version numbers.
## Publish to crates.io
## Publish to crates.io (Manual steps if needed)
1. Configure the crates.io credentials, if not already accomplished.
2. Execute `cargo publish -p veilid-tools --dry-run`
3. Execute `cargo publish -p veilid-tools`
4. Execute `cargo publish -p veilid-core --dry-run`
5. Execute `cargo publish -p veilid-core`
6. Execute `cargo publish -p veilid-remote-api --dry-run`
7. Execute `cargo publish -p veilid-remote-api`
## Publish to Pypi
## Publish to Pypi (Manual steps if needed)
1. Change directory to veilid-python
2. Install Poetry and configure the Pypi credentials, if not already accomplished.
@ -67,6 +69,9 @@ Occasionally a release will happen that needs to be reverted. This is done manua
- [x] __veilid-core__ [__Tag__: `veilid-core-v0.0.0`]
> The base rust crate for Veilid's logic
> Released to crates.io when its version number is changed in `Cargo.toml`
- [x] __veilid-remote-api__ [__Tag__: `veilid-remote-api-v0.0.0`]
> Exposes veilid-core's JSON API
> Released to crates.io when its version number is changed in `Cargo.toml`
- [ ] __veilid-server__
> The Veilid headless node end-user application
> Not released to crates.io as it is an application binary that is either built by hand or installed using a package manager.