Open adithyaov opened 10 months ago
Bugs targeted to 0.10.0
https://github.com/composewell/streamly/issues?q=is%3Aopen+is%3Aissue+label%3Atype%3Abug+milestone%3A0.10.0
All of them can be pushed to 0.10.1
. None of them are critical.
TODO:
file-path
(https://github.com/composewell/streamly/pull/2639)streamly-core
Release Checklist
[x] Check if any critical pending bugs or issues are to be included
[x] If this is a major release check if any previously deprecated features are to be removed in this release.
[x] Check pre-release APIs to be exposed, especially from streamly-examples
[x] PVP is adhered to, additionally do not change pre-release APIs in a minor release
[ ] Documentation:
master
branch of a few repositories. Pin them to a specific version that works with the current release.rg '/blob/'
andrg '/tree/'
to search for github links.streamly-examples
point to itsmaster
branch. Instead, while making the release we need to pin the links to a specific revision that works with the latest commit of the current release.docs
directory are consistent with new changessince
annotationInternal
orPre-release
annotations.Pre-release
orInternal
annotations[ ] Build and Test:
dev
flag) not covered by CIs[ ] Benchmarks:
bench-runner --long --quick
) to check for space leaks and to ensure constant memory usage for streaming operations.dev
flag on. Somefileio
benchmarks are disabled in regular runs.[ ] Dependencies:
stack.yaml
to latest stable resolver, cleanup extra-deps[ ] Dependent Packages:
[x] Update Package Metadata:
tested-with
fielddocs/Compiling.md
with the distributions tested withextra-source-files
in cabal file. Artifacts required for build, test, benchmarks, docs, licenses should be packaged. Build environment customization may or may not be packaged.[x] Copyrights and Contibutors
docs/CONTRIBUTORS.md
under the current release title.docs/Credits.md
and the license is added to the repo.[ ] Update changelog & Version:
./packdiff streamly ver1 streamly ver2
and record them indocs/User/ProjectRelated/ApiChangelogs/ver1-ver2.txt
.Unreleased
section at the top of changelog file has the new release version number and the month/year of publishing.rg '0\.8\.'|grep -v -i since
to find any remaining occurrences of the old release. Checkrg -i unreleased
for any remaining todos.[ ] Upload:
[ ] Wait for final CI tests to pass:
bin/run-ci.sh --targets ghcjs
.extra-source-files
, these wild-cards may match additional files lying around in the workspace and unintentionally ship them as well.cabal v2-sdist; cabal upload <tarpath>
cabal v2-haddock --haddock-for-hackage --enable-doc; cabal upload -d <tarpath>
cabal v2-sdist
;cabal upload --publish <tarpath>
cabal unpack <package-name>
. You might have to runcabal update
.git tag P-X.Y.Z && git push -f origin P-X.Y.Z
). If the package name is implicit, P can be omitted and the tag can be of the form vX.Y.Zbuild-constraints.yaml
in Stackage repo) if neededPost Release Tasks
streamly
andstreamly-docs
.Unreleased
section at the top of changelog file with the next major release target.