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
{{ message }}
This repository was archived by the owner on Jun 13, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: CHANGELOG.md
+21-1Lines changed: 21 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,25 @@
1
1
# TidalCycles log of changes
2
2
3
+
## 1.9.5 - Sashiko
4
+
5
+
## What's Changed
6
+
* avoid loading stream module in other modules, so hint wont crash by @polymorphicengine in https://github.com/tidalcycles/Tidal/pull/1019
7
+
* change streamGetnow to factor in the processAhead and also destroy the sessionstate by @polymorphicengine in https://github.com/tidalcycles/Tidal/pull/1025
8
+
* fix minor7sharp9 chord (the 9th wasn't sharp) by @cleary in https://github.com/tidalcycles/Tidal/pull/1036
9
+
* add metatune param, now against 1.9-dev by @ahihi in https://github.com/tidalcycles/Tidal/pull/1046
10
+
* Build fixes for Tidal 1.9 by @mindofmatthew in https://github.com/tidalcycles/Tidal/pull/1052
11
+
* Update link 1.9 dev by @yaxu in https://github.com/tidalcycles/Tidal/pull/1058
12
+
* More build fixes by @mindofmatthew in https://github.com/tidalcycles/Tidal/pull/1062
13
+
* Consolidate site docs into source docs, and some docs editing by @trespaul in https://github.com/tidalcycles/Tidal/pull/1070
14
+
* Fix negative numbers not working for boolean euclids by @geikha in https://github.com/tidalcycles/Tidal/pull/1063
15
+
16
+
## New Contributors
17
+
*@ahihi made their first contribution in https://github.com/tidalcycles/Tidal/pull/1046
18
+
*@trespaul made their first contribution in https://github.com/tidalcycles/Tidal/pull/1070
19
+
*@geikha made their first contribution in https://github.com/tidalcycles/Tidal/pull/1063
To run up your changes locally, install Tidal with `cabal install`. To remove them again and revert to the latest release, run `ghc-pkg unregister tidal-1.0.0` being sure to match up the version numbers. (note that ghc packaging is in a state of flux at the moment - this command might not actually work..)
85
85
86
-
# A process for making a release
86
+
# Making a Release
87
87
88
-
We haven't documented a clear process for this, but we'd like to
89
-
describe how to..
88
+
*Note: This may be incomplete—before making a release, it's a good idea to reach out to an existing project maintainer to double-check the process.*
90
89
91
-
* Share with others for testing
92
-
* Tag a release
93
-
* Distribute via hackage / stackage
90
+
First, you'll need to figure out the new version number. Tidal follows the [Haskell Package Versioning Policy](https://pvp.haskell.org/)—basically, for a given version (e.g. `v1.0.0`), only update the last number if you're releasing a minor, non-breaking change (so a bug fix release might be `v1.0.1`). A major release requires editing the first or second numbers (so a major release that substantially adds or changes functionality might be `v1.1.0`, and a release that rearchitects the fundamentals would be `v2.0.0`). Major releases include those that update dependencies to a new major release. It's also a good idea to do a major release for any bugfixes where performers have started using the "bug" for aesthetics.
91
+
92
+
## Get Permission
93
+
First, you need to do the following:
94
+
95
+
* Make sure that you have been given Owner permissions on the tidalcycles GitHub organization or the Tidal repository
96
+
* If you don't have one, [create a user account on Hackage](https://hackage.haskell.org/users/register-request). You'll also need to send an email to the Hackage Trustees mailing list to get upload permissions (the email you receive when you create your account will have details about this process).
97
+
* Make sure that you've been added to the maintainers group for the tidal package on Hackage
98
+
99
+
## Create a Draft Release in GitHub
100
+
101
+
* Draft a [new Tidal release](https://github.com/tidalcycles/Tidal/releases)
102
+
* The name of the release will be the human-readable nickname (some traditional form of pattern making or something else that strikes your fancy)
103
+
* For the tag, you can specify the next version in the form `v0.0.0` and GitHub will automatically tag the most recent commit whenever you publish the release
104
+
* The "Generate Release Notes" is an easy way to list all the relevant updates and new contributors. Feel free to edit this further as needed
105
+
***Save this as a draft for now**
106
+
107
+
## Update the Repository
108
+
109
+
Push any final changes to the code, updating the following files:
110
+
***[tidal.cabal](https://github.com/tidalcycles/Tidal/blob/1.10-dev/tidal.cabal)**: Change the version field
111
+
***Outdated Dependencies:** Run `cabal update` then `cabal outdated` to determine whether any of Tidal's dependencies are out of date, then update those as well
112
+
***[CHANGELOG.md](https://github.com/tidalcycles/Tidal/blob/1.10-dev/CHANGELOG.md)**: Add your new version at the top (you can copy the release notes from your draft GitHub release)
113
+
***[src/Sound/Tidal/Version.hs](https://github.com/tidalcycles/Tidal/blob/1.10-dev/src/Sound/Tidal/Version.hs)**: Update the version string here too. This is the version that's printed to the console when someone starts Tidal.
114
+
***If any of the other packages (e.g. tidal-link) have changed**: Update the respective **.cabal** files for these packages, and then update dependency information in **tidal.cabal** as needed.
115
+
116
+
## Test and Package the Repository
117
+
118
+
* Run `cabal test` to make sure all the tests pass (see above for details).
119
+
* Run `cabal haddock` and watch for errors to test that Cabal can generate the documentation for the package.
120
+
* Run `cabal check` to check for any errors with the package metadata.
121
+
* Run `cabal sdist` to generate an archive for distribution.
122
+
123
+
## Upload and Test Releases
124
+
125
+
*[The Hackage upload page](https://hackage.haskell.org/upload) contains instructions and links for uploading a release archive. **Start by uploading a package candidate because a package release can't be changed!**
126
+
* To distribute a package candidate for testing, find the download link for the `.tar.gz` bundle on the Hackage page for the package candidate. This candidate version can be installed with the following command: `cabal v1-install [url]` (note that at this time, [the v1 install command is necessary for installing a library from a URL](https://github.com/haskell/cabal/issues/8335)).
127
+
* Once everyone is happy with the new version, go ahead and upload the archive as a package release and publish the release on GitHub!
0 commit comments