Skip to content

Update README.md #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,23 @@
# build-manifests
Internal build manifests for all products.
This repository contains build manifests for the Couchbase Server and related projects. A build manifest is a YAML file that specifies the source code repositories and their revisions, along with build settings, required to build a particular version of a software product.

The build manifests in this repository are used by the Couchbase build system to build and package the Couchbase Server binaries, as well as other Couchbase projects like Sync Gateway, Lite Core, and C Mock.

## Manifest Structure

A typical build manifest in this repository consists of the following sections:

- 'vars': Defines variables that can be used in other sections of the manifest, such as the source code repositories and build settings.
- 'repos': Specifies the source code repositories and their revisions, along with any patches or other modifications to be applied to them.
- 'build': Configures the build settings, such as compiler flags, linker flags, and other options specific to the build platform and target architecture.
- 'targets': Defines the output targets of the build, such as binary executables, libraries, and test suites.
- 'packages': Specifies the packaging options for the output targets, such as file formats and compression settings.


## Getting Help
If you have any questions or issues with this repository, you can get help by creating a new issue in the GitHub issue tracker, or by asking for help in the Couchbase forums or community Slack channel.

## Contributing
Contributions to this repository are welcome. If you want to add support for a new platform or architecture, or update an existing manifest for a new release, you can create a pull request with your changes.

Before submitting a pull request, please make sure to test your changes by building the software using the updated manifest, and ensure that the resulting binaries are functional and meet the quality standards of the Couchbase project.