You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-`Version.props` — Single source of truth for the package version
13
+
-`Version.props` — Package version (derived automatically from `release-notes.txt`)
14
14
-`build.cmd` — Windows build/test script used by CI
15
15
16
16
## Build
@@ -102,12 +102,28 @@ All workflows are in `.github/workflows/`:
102
102
103
103
## Release Notes
104
104
105
-
**Required**: Every PR that adds features, fixes bugs, or makes user-visible changes **must** include an update to `release-notes.txt`. Add a bullet under the appropriate version heading (currently `0.5.0`). The format is:
105
+
`release-notes.txt` is the **single source of truth** for the package version. `Version.props` extracts the version automatically by finding the first line that matches a `X.Y.Z` semver pattern. The `Unreleased` section at the top of the file is skipped because it does not match this pattern.
106
+
107
+
**Format requirements:**
108
+
109
+
- The file **must** always begin with a heading line `Unreleased` (after the optional `Release notes:` header). This section holds in-progress changes before they are assigned a version number. It must always be present, even if empty.
110
+
- Below `Unreleased`, versioned sections are listed in descending order (`1.0.0`, `0.7.0`, …). The topmost versioned section determines the package version.
111
+
- To bump the version, add a new version heading between `Unreleased` and the previous version.
112
+
113
+
Example:
106
114
107
115
```
108
-
0.5.0
116
+
Release notes:
117
+
118
+
Unreleased
119
+
- upcoming change description
120
+
121
+
1.1.0
109
122
- adds TaskSeq.myFunction and TaskSeq.myFunctionAsync, #<issue>
110
123
- fixes <description>, #<issue>
124
+
125
+
1.0.0
126
+
- adds TaskSeq.withCancellation, #167
111
127
```
112
128
113
-
If you are bumping to a new version, also update `Version.props`. PRs that touch library source (`src/FSharp.Control.TaskSeq/`) without updating `release-notes.txt` are incomplete.
129
+
**Required**: Every PR that adds features, fixes bugs, or makes user-visible changes **must** add a bullet under the `Unreleased` heading in `release-notes.txt`. PRs that touch library source (`src/FSharp.Control.TaskSeq/`) without updating `release-notes.txt` are incomplete.
Copy file name to clipboardExpand all lines: release-notes.txt
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
2
2
Release notes:
3
3
4
-
1.0.1
4
+
Unreleased
5
5
- adds taskSeqDynamic computation expression and TaskSeqDynamic/TaskSeqDynamicInfo types for dynamic (FSI-compatible) resumable code, fixing issue where taskSeq would raise NotImplementedException in F# Interactive, #246
6
6
- perf: simplify iter, fold, reduce, mapFold, tryLast, skipOrTake (Drop/Truncate) to use while! and remove manual go-flag and initial MoveNextAsync pre-advance, matching the pattern already used by sum/sumBy/average
7
7
- perf: toResizeArrayAsync (and therefore toArrayAsync, toListAsync, toResizeArrayAsync, toIListAsync) uses a direct loop instead of going through iter, avoiding a lambda and DU allocation per call
0 commit comments