Git-Mirrors/veilid
1
0
Fork 0
mirror of https://gitlab.com/veilid/veilid.git synced 2024-10-01 01:26:08 -04:00
Code Issues Packages Projects Releases Wiki Activity
c08b28b240
veilid/RELEASING.md
TC Johnson f4d71457da
Add docs and mod version bumping 
Added and modified documentation for the contribution process.
Added the code of conduct file.
Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00

4.9 KiB
Raw Blame History

Veilid Release Process

Introduction

Veilid is a monorepo consisting of several projects:
(checked boxes are released as packages)

Release Mechanism

Releases happen via a CI/CD pipeline. The release process flows as follows:

  1. Maintainer responds to a merge request (MR): a. Evaluate the MR's adherence to the published requirements and if automatic tests passed. b. (Optional) Perform the merge in a local dev environment if testing is required beyond the standard Earthly tests. c. If everything checks out, MR meets the published requirements, and tests passed, execute the merge functions in the Gitlab UI.
  2. Maintainer performs version bump: a. Update your local copy of main to mirror the newly merged version b. Execute the bumpversion.py process. c. Push your local 'main' to the upstream origin 'main' git push d. Push the new tag to the upstream origin git push "tag name made in step 2d" e. Ensure the package/release/distribute pipeline autostarted in the Gitlab UI

Tags serve as a historical record of what repo versions were successfully released at which version numbers.

Reverting Releases

Occasionally a release will happen that needs to be reverted. This is done manually on crates.io or the APT repository, or wherever the artifacts end up. Tags are not removed.

Released Artifacts

Rust Crates:

  • veilid-tools [Tag: veilid-tools-v0.0.0]

    An assortment of useful components used by the other Veilid crates.
    Released to crates.io when its version number is changed in Cargo.toml

  • 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

  • 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.
    This application does not currently support cargo install

  • veilid-cli A text user interface to talk to veilid-server and operate it manually

    Not released to crates.io as it is an application binary that is either built by hand or installed using a package manager.
    This application does not currently support cargo install

  • veilid-wasm

    Not released to crates.io as it is not a library that can be linked by other Rust applications

  • veilid-flutter

    The Dart-FFI native interface to the Veilid API
    This is currently built by the Flutter plugin veilid-flutter and not released.

Python Packages:

  • veilid-python [Tag: veilid-python-v0.0.0]

    The Veilid API bindings for Python
    Released to PyPi when the version number is changed in pyproject.toml

Flutter Plugins:

  • veilid-flutter

    The Flutter plugin for the Veilid API.
    Because this requires a build of a native Rust crate, this is not yet released via https://pub.dev
    TODO: Eventually the rust crate should be bound to

Operating System Packages:

  • veilid-server DEB package [Tag: veilid-server-deb-v0.0.0]

    The Veilid headless node binary in the following formats:

    • Standalone Debian/Ubuntu DEB file as a 'release file' on the veilid GitLab repository
    • Pushed to APT repository at https://packages.veilid.net
  • veilid-server RPM package [Tag: veilid-server-rpm-v0.0.0]

    The Veilid headless node binary in the following formats:

    • Standalone RedHat/CentOS RPM file as a 'release file' on the veilid GitLab repository
    • Pushed to Yum repository at https://packages.veilid.net
  • veilid-cli DEB package [Tag: veilid-cli-deb-v0.0.0]

    The Veilid headless node administrator control binary in the following formats:

    • Standalone Debian/Ubuntu DEB file as a 'release file' on the veilid GitLab repository
    • Pushed to APT repository at https://packages.veilid.net
  • veilid-cli RPM package [Tag: veilid-cli-rpm-v0.0.0]

    The Veilid headless node administrator control binary in the following formats:

    • Standalone RedHat/CentOS RPM file as a 'release file' on the veilid GitLab repository
    • Pushed to Yum repository at https://packages.veilid.net

Version Numbering:

All versions of Veilid Rust crates as well as veilid-python and veilid-flutter packages are versioned using Semver. Versions can differ per crate and package, and it is important for the Semver rules to be followed (https://semver.org/):

  • MAJOR version when you make incompatible API changes
  • MINOR version when you add functionality in a backward compatible manner
  • PATCH version when you make backward compatible bug fixes

The version_bump.sh script should be run on every release to stable. All of the Rust crates are versioned together and should have the same version, as well as the veilid-python Python package and veilid-flutter Flutter plugin.