Skip to content

Commit 2688af7

Browse files
committed
[core] deprecate the master branch
1 parent 059823f commit 2688af7

File tree

3 files changed

+23
-2
lines changed

3 files changed

+23
-2
lines changed

CMakeLists.txt

+11
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,17 @@ cmake_minimum_required(VERSION 3.16)
33
project(Ginkgo LANGUAGES CXX VERSION 1.9.0 DESCRIPTION "A numerical linear algebra library targeting many-core architectures")
44
set(Ginkgo_VERSION_TAG "develop")
55
set(PROJECT_VERSION_TAG ${Ginkgo_VERSION_TAG})
6+
if(Ginkgo_VERSION_TAG STREQUAL "master")
7+
set(GINKGO_VERSION_TAG_DEPRECATED ON)
8+
else()
9+
set(GINKGO_VERSION_TAG_DEPRECATED OFF)
10+
endif()
11+
if(GINKGO_VERSION_TAG_DEPRECATED)
12+
message(
13+
WARNING
14+
"The branch ${Ginkgo_VERSION_TAG} is deprecated and will stop receiving updates after 2025. "
15+
"Please use the main branch for the latest release, or the develop branch for the latest development updates.")
16+
endif()
617
# Cuda and Hip also look for Threads. Set it before any find_package to ensure the Threads setting is not changed.
718
set(THREADS_PREFER_PTHREAD_FLAG ON)
819

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -151,8 +151,8 @@ improvements from code reviews.
151151
### Creating, Reviewing and Merging Pull Requests
152152

153153
* The `develop` branch is the default branch to submit PR's to. From time to
154-
time, we merge the `develop` branch to the `master` branch and create tags on
155-
the `master` to create new releases of Ginkgo. Therefore, all pull requests
154+
time, we merge the `develop` branch to the `main` branch and create tags on
155+
the `main` to create new releases of Ginkgo. Therefore, all pull requests
156156
must be merged into `develop`.
157157
* Please have a look at the labels and make sure to add the relevant labels.
158158
* You can mark the PR as a `WIP` if you are still working on it, `Ready for

include/ginkgo/config.hpp.in

+10
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,16 @@
1313
#define GKO_VERSION_STR @Ginkgo_VERSION_MAJOR@, @Ginkgo_VERSION_MINOR@, @Ginkgo_VERSION_PATCH@
1414
// clang-format on
1515

16+
17+
// clang-format off
18+
#cmakedefine01 GINKGO_VERSION_TAG_DEPRECATED
19+
#if GINKGO_VERSION_TAG_DEPRECATED
20+
#pragma message ("The branch " GKO_VERSION_TAG " is deprecated and will stop receiving updates after 2025. " \
21+
"Please use the main branch for the latest release, or the develop branch for the latest development updates.")
22+
#endif
23+
// clang-format on
24+
25+
1626
/*
1727
* Controls the amount of messages output by Ginkgo.
1828
* 0 disables all output (except for test, benchmarks and examples).

0 commit comments

Comments
 (0)