From 97e1a1137b92c0cf0fe56959cc8fcd5a60e13134 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Du=C5=A1an=20Baran?= Date: Fri, 3 Jan 2025 16:03:56 +0100 Subject: [PATCH] Prepare files for change of main branch name (#5407) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This PR changes all mentions of the `dev` branch as the default branch to branch name `main`. Follow up PRs: https://github.com/TileDB-Inc/conda-forge-nightly-controller/pull/161 https://github.com/TileDB-Inc/centralized-tiledb-nightlies/pull/32 --- TYPE: NO_HISTORY DESC: Change all mentions of default branch --------- Co-authored-by: Dušan Baran --- .github/DIRECTORY.md | 2 +- .github/workflows/build-docs.yml | 2 +- .github/workflows/full-ci.yml | 2 +- .github/workflows/quarto-render.yml | 2 +- .github/workflows/release.yml | 2 +- .github/workflows/test-cloud-e2e.yml | 2 +- .gitlab-ci.yml | 2 +- CONTRIBUTING.md | 15 +++++++-------- README.md | 16 ++++++++-------- bootstrap | 2 +- 10 files changed, 23 insertions(+), 24 deletions(-) diff --git a/.github/DIRECTORY.md b/.github/DIRECTORY.md index 63e003ea3a2..d9b8435bdb8 100644 --- a/.github/DIRECTORY.md +++ b/.github/DIRECTORY.md @@ -30,4 +30,4 @@ the version-specific tests. This fan-out setup reduces the runtime of each job f ## Documentation -Documentation is built by `workflows/build-docs.yml` using `/scripts/ci/build_docs.sh`. \ No newline at end of file +Documentation is built by `workflows/build-docs.yml` using `/scripts/ci/build_docs.sh`. diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml index 31c15addeda..e03d566a337 100644 --- a/.github/workflows/build-docs.yml +++ b/.github/workflows/build-docs.yml @@ -2,7 +2,7 @@ name: build-docs on: push: branches: - - dev + - main - 'release-*' paths-ignore: - '.github/workflows/quarto-render.yml' diff --git a/.github/workflows/full-ci.yml b/.github/workflows/full-ci.yml index 316b5b56f16..3b00a6ab6c3 100644 --- a/.github/workflows/full-ci.yml +++ b/.github/workflows/full-ci.yml @@ -3,7 +3,7 @@ on: workflow_dispatch: push: branches: - - dev + - main - release-* - refs/tags/* diff --git a/.github/workflows/quarto-render.yml b/.github/workflows/quarto-render.yml index 7a6a8eec066..f81f2e44b83 100644 --- a/.github/workflows/quarto-render.yml +++ b/.github/workflows/quarto-render.yml @@ -4,7 +4,7 @@ name: Render and deploy Quarto files on: push: # publish on merge only - branches: dev + branches: main # when changes match any path below paths: - '.github/workflows/quarto-render.yml' diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 18eb1f515ee..6aad2377c2e 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -4,7 +4,7 @@ on: workflow_dispatch: push: branches: - - dev + - main - 'release-*' tags: - '*' diff --git a/.github/workflows/test-cloud-e2e.yml b/.github/workflows/test-cloud-e2e.yml index dae04836de7..102c8dacd1c 100644 --- a/.github/workflows/test-cloud-e2e.yml +++ b/.github/workflows/test-cloud-e2e.yml @@ -9,7 +9,7 @@ on: type: boolean push: branches: - - dev + - main - release-* env: diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 0cb52e92984..294109c1b26 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -4,7 +4,7 @@ stages: trigger_pipeline: stage: test rules: - - if: $CI_COMMIT_BRANCH =~ /^dev|^release-.*/ || $CI_COMMIT_TAG != "" # only/except rules are no longer actively developed. Please use `rules` instead. + - if: $CI_COMMIT_BRANCH =~ /^main|^release-.*/ || $CI_COMMIT_TAG != "" # only/except rules are no longer actively developed. Please use `rules` instead. - if: $CI_PIPELINE_SOURCE == "external_pull_request_event" changes: - "!.github/workflows/quarto-render.yml" diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 627ab9af9e4..205725e0468 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,9 +5,9 @@ help you file issues, bug reports, or contribute code to the open source TileDB ## Contribution Checklist: -* Reporting a bug? Please read [how to file a bug report](https://github.com/TileDB-Inc/TileDB/blob/dev/CONTRIBUTING.md#reporting-a-bug) section to make sure sufficient information is included. +* Reporting a bug? Please read [how to file a bug report](https://github.com/TileDB-Inc/TileDB/blob/main/CONTRIBUTING.md#reporting-a-bug) section to make sure sufficient information is included. -* Contributing code? You rock! Be sure to [review the contributor section](https://github.com/TileDB-Inc/TileDB/blob/dev/CONTRIBUTING.md#contributing-code) for helpful tips on the tools we use to build TileDB, format code, and issue pull requests (PR)'s. +* Contributing code? You rock! Be sure to [review the contributor section](https://github.com/TileDB-Inc/TileDB/blob/main/CONTRIBUTING.md#contributing-code) for helpful tips on the tools we use to build TileDB, format code, and issue pull requests (PR)'s. ## Reporting a Bug @@ -16,7 +16,7 @@ A useful bug report filed as a GitHub issue provides information about how to re 1. Before opening a new [GitHub issue](https://github.com/TileDB-Inc/TileDB/issues) try searching the existing issues to see if someone else has already noticed the same problem. 2. When filing a bug report, provide where possible: - - The version TileDB (`tiledb_version()`) or if a `dev` version, specific commit that triggers the error. + - The version TileDB (`tiledb_version()`) or if a `main` version, specific commit that triggers the error. - The full error message, including the backtrace (if possible). Verbose error reporting is enabled by building TileDB with `../bootstrap --enable-verbose`. - A minimal working example, i.e. the smallest chunk of code that triggers the error. Ideally, this should be code that can be a small reduced C / C++ source file. If the code to reproduce is somewhat long, consider putting it in a [gist](https://gist.github.com). @@ -25,7 +25,7 @@ A useful bug report filed as a GitHub issue provides information about how to re ## Contributing Code -*By contributing code to TileDB, you are agreeing to release it under the [MIT License](https://github.com/TileDB-Inc/TileDB/tree/dev/LICENSE).* +*By contributing code to TileDB, you are agreeing to release it under the [MIT License](https://github.com/TileDB-Inc/TileDB/tree/main/LICENSE).* ### Quickstart Workflow: @@ -49,8 +49,7 @@ for dependencies and detailed build instructions. [Issue a PR from your updated TileDB fork](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) Branch conventions: -- `dev` is the development branch of TileDB, all PR's are merged into `dev`. -- `master` tracks the latest stable / released version of TileDB. +- `main` is the development branch of TileDB, all PR's are merged into `main`. - `release-x.y.z` are major / bugfix release branches of TileDB. Formatting conventions: @@ -63,13 +62,13 @@ Formatting conventions: ### Pull Requests: -- `dev` is the development branch, all PR’s should be rebased on top of the latest `dev` commit. +- `main` is the development branch, all PR’s should be rebased on top of the latest `main` commit. - Commit changes to a local branch. The convention is to use your initials to identify branches: (ex. “Fred Jones” , `fj/my_bugfix_branch`). Branch names should be identifiable and reflect the feature or bug that they want to address / fix. This helps in deleting old branches later. - Make sure the test suite passes by running `make check`. -- When ready to submit a PR, `git rebase` the branch on top of the latest `dev` commit. Be sure to squash / cleanup the commit history so that the PR preferably one, or a couple commits at most. Each atomic commit in a PR should be able to pass the test suite. +- When ready to submit a PR, `git rebase` the branch on top of the latest `main` commit. Be sure to squash / cleanup the commit history so that the PR preferably one, or a couple commits at most. Each atomic commit in a PR should be able to pass the test suite. - Run the limiting / code format tooling (`make format`) before submitting a final PR. Make sure that your contribution generally follows the format and naming conventions used by surrounding code. diff --git a/README.md b/README.md index 02b74aad5c5..a380abc65e5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -TileDB logo +TileDB logo -[![Full CI](https://github.com/TileDB-Inc/TileDB/actions/workflows/full-ci.yml/badge.svg?branch=dev)](https://github.com/TileDB-Inc/TileDB/actions/workflows/full-ci.yml) [![Azure Pipelines](https://dev.azure.com/TileDB-Inc/CI/_apis/build/status/TileDB-Inc.TileDB?branchName=dev)](https://dev.azure.com/TileDB-Inc/CI/_build/latest?definitionId=2&branchName=dev) [![](doc/anaconda.svg)![Anaconda download count badge](https://anaconda.org/conda-forge/TileDB/badges/downloads.svg)](https://anaconda.org/conda-forge/TileDB) +[![Full CI](https://github.com/TileDB-Inc/TileDB/actions/workflows/full-ci.yml/badge.svg?branch=main)](https://github.com/TileDB-Inc/TileDB/actions/workflows/full-ci.yml) [![Azure Pipelines](https://dev.azure.com/TileDB-Inc/CI/_apis/build/status/TileDB-Inc.TileDB?branchName=main)](https://dev.azure.com/TileDB-Inc/CI/_build/latest?definitionId=2&branchName=main) [![](doc/anaconda.svg)![Anaconda download count badge](https://anaconda.org/conda-forge/TileDB/badges/downloads.svg)](https://anaconda.org/conda-forge/TileDB) # The Universal Storage Engine @@ -41,10 +41,10 @@ $ docker pull tiledb/tiledb $ docker run -it tiledb/tiledb ``` -We include several [examples](https://github.com/TileDB-Inc/TileDB/tree/dev/examples). You can start with the following: +We include several [examples](https://github.com/TileDB-Inc/TileDB/tree/main/examples). You can start with the following: -* [Dense array example](https://github.com/TileDB-Inc/TileDB/blob/dev/examples/cpp_api/quickstart_dense.cc) -* [Sparse array example](https://github.com/TileDB-Inc/TileDB/blob/dev/examples/cpp_api/quickstart_sparse.cc) +* [Dense array example](https://github.com/TileDB-Inc/TileDB/blob/main/examples/cpp_api/quickstart_dense.cc) +* [Sparse array example](https://github.com/TileDB-Inc/TileDB/blob/main/examples/cpp_api/quickstart_sparse.cc) ## Documentation @@ -71,8 +71,8 @@ The TileDB data format is open-source and can be found [here](format_spec/FORMAT The TileDB team maintains a variety of APIs built on top of the C++ library: -* C ([examples](https://github.com/TileDB-Inc/TileDB/tree/dev/examples/c_api), [API docs](https://tiledb-inc-tiledb.readthedocs-hosted.com/en/stable/c-api.html)) -* C++ ([examples](https://github.com/TileDB-Inc/TileDB/tree/dev/examples/cpp_api), [API docs](https://tiledb-inc-tiledb.readthedocs-hosted.com/en/stable/c++-api.html)) +* C ([examples](https://github.com/TileDB-Inc/TileDB/tree/main/examples/c_api), [API docs](https://tiledb-inc-tiledb.readthedocs-hosted.com/en/stable/c-api.html)) +* C++ ([examples](https://github.com/TileDB-Inc/TileDB/tree/main/examples/cpp_api), [API docs](https://tiledb-inc-tiledb.readthedocs-hosted.com/en/stable/c++-api.html)) * [Python](https://github.com/TileDB-Inc/TileDB-Py) * [R](https://github.com/TileDB-Inc/TileDB-R) * [Java](https://github.com/TileDB-Inc/TileDB-Java) @@ -91,6 +91,6 @@ TileDB is also integrated with several popular databases and data science tools: ## Get involved -TileDB Embedded is an open-source project and welcomes all forms of contributions. Contributors to the project should read over the [contribution docs](https://github.com/TileDB-Inc/TileDB/blob/dev/CONTRIBUTING.md) for more information. +TileDB Embedded is an open-source project and welcomes all forms of contributions. Contributors to the project should read over the [contribution docs](https://github.com/TileDB-Inc/TileDB/blob/main/CONTRIBUTING.md) for more information. We'd love to hear from you. Drop us a line at [hello@tiledb.com](mailto:hello@tiledb.com), visit our [forum](https://forum.tiledb.com/) or [contact form](https://tiledb.com/contact), or [follow us on Twitter](https://twitter.com/tiledb) to stay informed of updates and news. diff --git a/bootstrap b/bootstrap index 5ae7321b8c7..a6a305de0f8 100755 --- a/bootstrap +++ b/bootstrap @@ -119,7 +119,7 @@ while test $# != 0; do --dependency=*) dir=`arg "$1"` dependency_dir="$dir";; --linkage=*) linkage=`arg "$1"`;; - --force-build-all-deps) echo "Argument '--force-build-all-deps' has no effect and will be removed in a future version. Vcpkg builds all dependencies by default, please consult the guide in doc/dev/BUILD.md or vcpkg's documentation to see how to provide your own dependencies.";; + --force-build-all-deps) echo "Argument '--force-build-all-deps' has no effect and will be removed in a future version. Vcpkg builds all dependencies by default, please consult the guide in doc/main/BUILD.md or vcpkg's documentation to see how to provide your own dependencies.";; --remove-deprecations) tiledb_remove_deprecations="ON";; --disable-werror) tiledb_werror="OFF";; --disable-tests) tiledb_tests="OFF";;