on master help sign in
Move Api Changelogs to a directory
commitc4ad0a52fa5559189e07bde829833e7cdec36dc8 authorAdithya Kumar <adithya@composewell.com> dateWed 8 Mar 2023, 23:44 (4 years ago) parentf916fbc
8 files changed+10−8
core/docs/API-Changelog-0.1.0.txt → core/docs/ApiChangelogs/0.1.0.txt core/streamly-core.cabal+1 docs/Developer/MAINTAINING.md+2−2 docs/User/ProjectRelated/API-Changelog-0.8.3-0.9.0.txt → docs/User/ProjectRelated/ApiChangelogs/0.8.3-0.9.0.txt docs/User/ProjectRelated/API-changelog.txt → docs/User/ProjectRelated/ApiChangelogs/0.8.3.txt docs/User/ProjectRelated/Changelog.md+3−3 docs/streamly-docs.cabal+2−1 streamly.cabal+2−2
core/docs/API-Changelog-0.1.0.txt → core/docs/ApiChangelogs/0.1.0.txtrenamed

The content is the same.

core/streamly-core.cabal+1
@@ -54,6 +54,7 @@ extra-tmp-files:
5454extra-doc-files:
5555 Changelog.md
5656 docs/*.md
57+ docs/ApiChangelogs/0.1.0.txt
5758
5859source-repository head
5960 type: git
docs/Developer/MAINTAINING.md+2−2
@@ -119,8 +119,8 @@
119119
120120* _Update changelog & Version_:
121121
122− * Find API changes using `cabal-diff streamly <previous-release-version> .`
123− and record them in docs/API-changelog.txt.
122+ * Find API changes using `./packdiff streamly ver1 streamly ver2`
123+ and record them in `docs/User/ProjectRelated/ApiChangelogs/ver1-ver2.txt`.
124124 * Make sure all the bug fixes being included in this release are marked
125125 with a target release on github. So that users can search by release if
126126 they want.
docs/User/ProjectRelated/API-Changelog-0.8.3-0.9.0.txt → docs/User/ProjectRelated/ApiChangelogs/0.8.3-0.9.0.txtrenamed

The content is the same.

docs/User/ProjectRelated/API-changelog.txt → docs/User/ProjectRelated/ApiChangelogs/0.8.3.txtrenamed

The content is the same.

docs/User/ProjectRelated/Changelog.md+3−3
@@ -97,7 +97,7 @@ Following modules are moved to `streamly-core` package and renamed:
9797
9898## 0.8.1 (Nov 2021)
9999
100−See API-changelog.txt for new APIs introduced.
100+See ApiChangelogs/0.8.3.txt for new APIs introduced.
101101
102102### Bug Fixes
103103
@@ -125,7 +125,7 @@ See API-changelog.txt for new APIs introduced.
125125
126126## 0.8.0 (Jun 2021)
127127
128−See [API Changelog](/docs/User/ProjectRelated/API-changelog.txt) for a complete list of signature
128+See [API Changelog](/docs/User/ProjectRelated/ApiChangelogs/0.8.3.txt) for a complete list of signature
129129changes and new APIs introduced.
130130
131131### Breaking changes
@@ -164,7 +164,7 @@ changes and new APIs introduced.
164164
165165### Enhancements
166166
167−* See [API Changelog](/docs/User/ProjectRelated/API-changelog.txt) for a complete list of new
167+* See [API Changelog](/docs/User/ProjectRelated/ApiChangelogs/0.8.3.txt) for a complete list of new
168168 modules and APIs introduced.
169169* The Fold type is now more powerful, the new termination behavior allows
170170 to express basic parsing of streams using folds.
docs/streamly-docs.cabal+2−1
@@ -25,7 +25,8 @@ extra-doc-files:
2525 User/Explanatory/streaming-pradigms.rst
2626 User/ProjectRelated/*.md
2727 User/ProjectRelated/*.link
28− User/ProjectRelated/API-changelog.txt
28+ User/ProjectRelated/ApiChangelogs/0.8.3.txt
29+ User/ProjectRelated/ApiChangelogs/0.8.3-0.9.0.txt
2930 Developer/*.png
3031 Developer/*.md
3132 Developer/*.link
streamly.cabal+2−2
@@ -162,8 +162,8 @@ extra-doc-files:
162162 docs/User/Explanatory/streaming-pradigms.rst
163163 docs/User/ProjectRelated/*.md
164164 docs/User/ProjectRelated/*.link
165− docs/User/ProjectRelated/API-Changelog-0.8.3-0.9.0.txt
166− docs/User/ProjectRelated/API-changelog.txt
165+ docs/User/ProjectRelated/ApiChangelogs/0.8.3-0.9.0.txt
166+ docs/User/ProjectRelated/ApiChangelogs/0.8.3.txt
167167 test/README.md
168168 docs/Developer/Tests.md
169169