Skip to content

Commit 0c19df0

Browse files
authored
Merge pull request seqan#299 from eseiler/misc/bump
chore: bump version
2 parents 015cacc + 4ed61ef commit 0c19df0

File tree

8 files changed

+98
-20
lines changed

8 files changed

+98
-20
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ OPTIONS
158158
VERSION
159159
Last update:
160160
Eat-Me-App version:
161-
Sharg version: 1.2.0
161+
Sharg version: 1.2.1-rc.1
162162
```
163163
<!-- MARKDOWN-AUTO-DOCS:END -->
164164

include/sharg/version.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@
1717
//!\brief The minor version as MACRO.
1818
#define SHARG_VERSION_MINOR 2
1919
//!\brief The patch version as MACRO.
20-
#define SHARG_VERSION_PATCH 0
20+
#define SHARG_VERSION_PATCH 1
2121
//!\brief The release candidate number. 0 means stable release, >= 1 means release candidate.
22-
#define SHARG_RELEASE_CANDIDATE 0
22+
#define SHARG_RELEASE_CANDIDATE 1
2323

2424
//!\brief The full version as MACRO (number).
2525
#define SHARG_VERSION (SHARG_VERSION_MAJOR * 10000 + SHARG_VERSION_MINOR * 100 + SHARG_VERSION_PATCH)
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
From 7353a6da25516f7532339b0b647d5a767e4ccad4 Mon Sep 17 00:00:00 2001
2+
From: Enrico Seiler <enrico.seiler@hotmail.de>
3+
Date: Thu, 15 Jan 2026 20:25:02 +0100
4+
Subject: [PATCH] [NOAPI] Bump version
5+
6+
---
7+
test/snippet/readme_sneak_peek.out | 2 +-
8+
test/unit/detail/format_ctd_test.cpp | 2 +-
9+
test/unit/detail/format_cwl_test.cpp | 2 +-
10+
3 files changed, 3 insertions(+), 3 deletions(-)
11+
12+
diff --git a/test/snippet/readme_sneak_peek.out b/test/snippet/readme_sneak_peek.out
13+
index e51f728..1e30290 100644
14+
--- a/test/snippet/readme_sneak_peek.out
15+
+++ b/test/snippet/readme_sneak_peek.out
16+
@@ -28,4 +28,4 @@ OPTIONS
17+
VERSION
18+
Last update:
19+
Eat-Me-App version:
20+
- Sharg version: 1.2.0
21+
+ Sharg version: 1.2.1-rc.1
22+
diff --git a/test/unit/detail/format_ctd_test.cpp b/test/unit/detail/format_ctd_test.cpp
23+
index 320119b..b8d8523 100644
24+
--- a/test/unit/detail/format_ctd_test.cpp
25+
+++ b/test/unit/detail/format_ctd_test.cpp
26+
@@ -114,7 +114,7 @@ TEST_F(format_ctd_test, empty_information)
27+
// Create the dummy parser.
28+
auto parser = get_parser("--export-help", "ctd");
29+
parser.info.date = "December 01, 1994";
30+
- parser.info.version = "1.2.0";
31+
+ parser.info.version = "1.2.1-rc.1";
32+
parser.info.man_page_title = "default_man_page_title";
33+
parser.info.short_description = "A short description here.";
34+
35+
diff --git a/test/unit/detail/format_cwl_test.cpp b/test/unit/detail/format_cwl_test.cpp
36+
index dece1f7..990ea66 100644
37+
--- a/test/unit/detail/format_cwl_test.cpp
38+
+++ b/test/unit/detail/format_cwl_test.cpp
39+
@@ -21,7 +21,7 @@ TEST_F(format_cwl_test, empty_information)
40+
// Create the dummy parser.
41+
auto parser = get_parser("--export-help", "cwl");
42+
parser.info.date = "December 01, 1994";
43+
- parser.info.version = "1.2.0";
44+
+ parser.info.version = "1.2.1-rc.1";
45+
parser.info.man_page_title = "default_man_page_title";
46+
parser.info.short_description = "A short description here.";
47+
48+
--
49+
2.47.3
50+

test/api_stability/CMakeLists.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ find_package (Git)
1515
include (../sharg-test.cmake)
1616

1717
include (ExternalProject)
18-
set (SHARG_LAST_STABLE_VERSION "1.1.1")
18+
set (SHARG_LAST_STABLE_VERSION "1.2.0")
1919
set (SHARG_LAST_STABLE_SOURCE_URL
2020
"https://github.com/seqan/sharg-parser/releases/download/${SHARG_LAST_STABLE_VERSION}/sharg-${SHARG_LAST_STABLE_VERSION}-Source.tar.xz"
2121
)
22-
set (SHARG_LAST_STABLE_SOURCE_SHA256 "7330f06501718e7871e55e5fd70d0e41472cc8b34bd0e3519f8c5547510c671c")
22+
set (SHARG_LAST_STABLE_SOURCE_SHA256 "aac491bbde0d4d5446277c7c1f6cb4b814b2b4793b14b77f9838f139d50ae29f")
2323

2424
set (SHARG_API_STABILITY_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DSHARG_DISABLE_DEPRECATED_WARNINGS=1")
2525

test/api_stability/README.md

Lines changed: 40 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@ CMAKE_BUILD_PARALLEL_LEVEL=40 cmake --build .
2929

3030
### How does this work?
3131

32-
In the following we will use `1.1.1` as the latest stable release (LSR).
32+
In the following we will use `1.2.0` as the latest stable release (LSR).
3333

3434
The workflow entails these steps:
3535
1. Download and unzip the LSR.
3636
2. Remove everything from the LSR except the tests in `<sharg_lsr_source>/test/`.
3737
3. Apply patches from the current git version on the LSR, i.e., patches found in
38-
`<sharg_git_source>/test/api_stability/1.1.1`.
38+
`<sharg_git_source>/test/api_stability/1.2.0`.
3939
* These patches will only apply changes on the tests.
4040
* This step is necessary as some of our tests also test non-public / non-stable API.
4141
3. Use the current version of `find_package (Sharg)` found in `<sharg_git_source>/cmake`.
@@ -84,25 +84,50 @@ There are two categories of API changes that are reflected in the patches (prefi
8484

8585
### How to create patches?
8686

87-
In the following, we will use `1.1.1` as the latest stable release (LSR).
87+
<details><summary>Click for tl;dr<summary>
8888

89-
Create a new branch based on the LSR and apply all existing patches in `<sharg_git_source>/test/api_stability/1.1.1`.
89+
```bash
90+
git update-ref -d refs/heads/api-stability-patches
91+
mkdir -p /tmp/sharg-api-stability-patches
92+
cp -u=all test/api_stability/1.2.0/*.patch /tmp/sharg-api-stability-patches
93+
git checkout -b api-stability-patches 1.2.0
94+
git am --keep-non-patch /tmp/sharg-api-stability-patches/*.patch
95+
rm -f /tmp/sharg-api-stability-patches/*.patch
96+
97+
git cherry-pick <commit>
98+
99+
git format-patch 1.2.0
100+
mv *.patch /tmp/sharg-api-stability-patches
101+
git checkout -
102+
cp -u /tmp/sharg-api-stability-patches/*.patch test/api_stability/1.2.0/
103+
rm -rf /tmp/sharg-api-stability-patches
104+
git branch -D api-stability-patches
105+
106+
git add test/api_stability/1.2.0/
107+
git commit
108+
```
109+
110+
</details>
111+
112+
In the following, we will use `1.2.0` as the latest stable release (LSR).
113+
114+
Create a new branch based on the LSR and apply all existing patches in `<sharg_git_source>/test/api_stability/1.2.0`.
90115

91116
```
92117
cd <sharg_git_source>
93118
94119
# copy over patches to a tmp directory (`git am` seems to not support applying patches onto a different branch)
95120
mkdir -p /tmp/sharg-api-stability-patches
96-
cp test/api_stability/1.1.1/*.patch /tmp/sharg-api-stability-patches
121+
cp test/api_stability/1.2.0/*.patch /tmp/sharg-api-stability-patches
97122
98123
# create a new branch based on the LSR and switch to it
99-
git checkout -b api-stability-patches 1.1.1
124+
git checkout -b api-stability-patches 1.2.0
100125
101-
# apply all patches onto 1.1.1 (--keep-non-patch will keep `[NOAPI]` tags in the commit message)
126+
# apply all patches onto 1.2.0 (--keep-non-patch will keep `[NOAPI]` tags in the commit message)
102127
git am --keep-non-patch /tmp/sharg-api-stability-patches/*.patch
103128
104129
# clean up applied patches
105-
rm /tmp/sharg-api-stability-patches/*.patch
130+
rm -f /tmp/sharg-api-stability-patches/*.patch
106131
```
107132

108133
Now re-apply the commit(s) that changed the API.
@@ -129,8 +154,8 @@ It is also important that you double check if the patch only contains changes th
129154
After that, we can export all patches.
130155

131156
```
132-
# export all patches since 1.1.1
133-
git format-patch 1.1.1
157+
# export all patches since 1.2.0
158+
git format-patch 1.2.0
134159
135160
# move them to tmp directory
136161
mv *.patch /tmp/sharg-api-stability-patches
@@ -141,15 +166,18 @@ Now change to your branch that you were working on and check-in the patches.
141166
```
142167
git checkout -
143168
144-
cp /tmp/sharg-api-stability-patches/*.patch test/api_stability/1.1.1/
169+
cp -u /tmp/sharg-api-stability-patches/*.patch test/api_stability/1.2.0/
145170
146171
rm -rf /tmp/sharg-api-stability-patches
147172
148173
# add new patches
149-
git add test/api_stability/1.1.1/
174+
git add test/api_stability/1.2.0/
150175
151176
# commit changes
152177
git commit
178+
179+
# delete local branch
180+
git branch -D api-stability-patches
153181
```
154182

155183
Before pushing, try whether the patches work as intended.

test/snippet/readme_sneak_peek.out

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ OPTIONS
2828
VERSION
2929
Last update:
3030
Eat-Me-App version:
31-
Sharg version: 1.2.0
31+
Sharg version: 1.2.1-rc.1

test/unit/detail/format_ctd_test.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ TEST_F(format_ctd_test, empty_information)
114114
// Create the dummy parser.
115115
auto parser = get_parser("--export-help", "ctd");
116116
parser.info.date = "December 01, 1994";
117-
parser.info.version = "1.2.0";
117+
parser.info.version = "1.2.1-rc.1";
118118
parser.info.man_page_title = "default_man_page_title";
119119
parser.info.short_description = "A short description here.";
120120

test/unit/detail/format_cwl_test.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ TEST_F(format_cwl_test, empty_information)
2121
// Create the dummy parser.
2222
auto parser = get_parser("--export-help", "cwl");
2323
parser.info.date = "December 01, 1994";
24-
parser.info.version = "1.2.0";
24+
parser.info.version = "1.2.1-rc.1";
2525
parser.info.man_page_title = "default_man_page_title";
2626
parser.info.short_description = "A short description here.";
2727

0 commit comments

Comments
 (0)