Release Guide
This is the release guide for Legend, including Legend Omnibus and various Legend components (engine, SDLC, etc.), some of which will eventually be moved into the relevant projects.
Legend Omnibus is an all-in-one, zero-configuration, zero-setup distribution of Legend; and we use it to record the combinations of Legend components that work together. Its releases are tracked at https://legend.finos.org/releases
Note that the main point of this release is to keep a record of the combination of various Legend components (as well as their configs) that work with one another. To ensure the configs stay up-to-date, we have scheduled a workflow to test and publish the omnibus running on the
snapshotsof all the components so that breaking changes are made in the components (their startup mechanism, config, etc.), we would be alerted of this
To create a new release of Legend Omnibus, manually trigger the (Manual) Create New Docker Release pipeline. This pipeline will ask for various Legend components' versions, please provide the ones that need a bump, the tag for the Legend Omnibus could be left blank and that would default to the current date in YYYY-MM-DD format (e.g., 2019-10-01). See the screenshot below for an example:
Please consult these guides for project-specific information. And if the guides are unclear, please open issues/PRs in the projects directly.
- Legend Pure: https://github.com/finos/legend/wiki/Release-Management---Legend-Pure
- Legend Engine: https://github.com/finos/legend/wiki/Release-Management---Legend-Engine
- Legend Studio: https://github.com/finos/legend-studio/blob/master/docs/workflow/release-process.md
The Legend projects are actively being refactored to enable a smoother contribution and release workflow. The build process, release process, etc are actively being changed.
- legend-maintainers - Maintainers for the Legend ecosystem. See https://github.com/orgs/finos/teams/legend-maintainers/members
- legend-XXX-maintainers_ - Maintainers for the XXX project. e.g. https://github.com/orgs/finos/teams/legend-engine-maintainers
Various Gtihub actions use credentials and other sensitive material. Add this material as a secret requires admin privileges on the project and needs to be coordinated with legend-maintainers or legend-XXX-maintainers
If the Maven central UI does not show versions that have just been released. Use this URL instead https://repo1.maven.org/maven2/org/finos/legend/engine/legend-engine/3.13.0/