Skip to content

Commit

Permalink
Merge pull request #1071 from mindofmatthew/1.10-dev
Browse files Browse the repository at this point in the history
v1.9.5 bump
  • Loading branch information
matthewkaney authored Apr 7, 2024
2 parents d130059 + d80b501 commit 88f09ed
Show file tree
Hide file tree
Showing 5 changed files with 66 additions and 12 deletions.
22 changes: 21 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,25 @@
# TidalCycles log of changes

## 1.9.5 - Sashiko

## What's Changed
* avoid loading stream module in other modules, so hint wont crash by @polymorphicengine in https://github.com/tidalcycles/Tidal/pull/1019
* change streamGetnow to factor in the processAhead and also destroy the sessionstate by @polymorphicengine in https://github.com/tidalcycles/Tidal/pull/1025
* fix minor7sharp9 chord (the 9th wasn't sharp) by @cleary in https://github.com/tidalcycles/Tidal/pull/1036
* add metatune param, now against 1.9-dev by @ahihi in https://github.com/tidalcycles/Tidal/pull/1046
* Build fixes for Tidal 1.9 by @mindofmatthew in https://github.com/tidalcycles/Tidal/pull/1052
* Update link 1.9 dev by @yaxu in https://github.com/tidalcycles/Tidal/pull/1058
* More build fixes by @mindofmatthew in https://github.com/tidalcycles/Tidal/pull/1062
* Consolidate site docs into source docs, and some docs editing by @trespaul in https://github.com/tidalcycles/Tidal/pull/1070
* Fix negative numbers not working for boolean euclids by @geikha in https://github.com/tidalcycles/Tidal/pull/1063

## New Contributors
* @ahihi made their first contribution in https://github.com/tidalcycles/Tidal/pull/1046
* @trespaul made their first contribution in https://github.com/tidalcycles/Tidal/pull/1070
* @geikha made their first contribution in https://github.com/tidalcycles/Tidal/pull/1063

**Full Changelog**: https://github.com/tidalcycles/Tidal/compare/v1.9.4...v1.9.5

## 1.9.4 - Stitch

### What's Changed
Expand All @@ -17,7 +37,7 @@

**Full Changelog**: https://github.com/tidalcycles/Tidal/compare/v1.9.3...v1.9.4

### 1.9.3 - Kolam
## 1.9.3 - Kolam

### What's Changed
* fix for squeezejoin by @yaxu in https://github.com/tidalcycles/Tidal/pull/950
Expand Down
48 changes: 41 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ compiler/interpreter. Some resources for learning Haskell can be found here:
The main repository is maintained on github:
https://github.com/tidalcycles/tidal

**At the time of writing, current work should target the '1.9-dev' branch. The 2.0-dev branch is for experiments towards version 2.0.**
**At the time of writing, current work should target the '1.10-dev' branch. The 2.0-dev branch is for experiments towards version 2.0.**

The SuperDirt repository is here:
https://github.com/musikinformatik/SuperDirt
Expand Down Expand Up @@ -83,11 +83,45 @@ firefox dist/hpc/prof/html/tests/hpc_index.html

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..)

# A process for making a release
# Making a Release

We haven't documented a clear process for this, but we'd like to
describe how to..
*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.*

* Share with others for testing
* Tag a release
* Distribute via hackage / stackage
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.

## Get Permission
First, you need to do the following:

* Make sure that you have been given Owner permissions on the tidalcycles GitHub organization or the Tidal repository
* 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).
* Make sure that you've been added to the maintainers group for the tidal package on Hackage

## Create a Draft Release in GitHub

* Draft a [new Tidal release](https://github.com/tidalcycles/Tidal/releases)
* The name of the release will be the human-readable nickname (some traditional form of pattern making or something else that strikes your fancy)
* 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
* 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
* **Save this as a draft for now**

## Update the Repository

Push any final changes to the code, updating the following files:
* **[tidal.cabal](https://github.com/tidalcycles/Tidal/blob/1.10-dev/tidal.cabal)**: Change the version field
* **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
* **[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)
* **[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.
* **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.

## Test and Package the Repository

* Run `cabal test` to make sure all the tests pass (see above for details).
* Run `cabal haddock` and watch for errors to test that Cabal can generate the documentation for the package.
* Run `cabal check` to check for any errors with the package metadata.
* Run `cabal sdist` to generate an archive for distribution.

## Upload and Test Releases

* [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!**
* 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)).
* Once everyone is happy with the new version, go ahead and upload the archive as a package release and publish the release on GitHub!
2 changes: 1 addition & 1 deletion src/Sound/Tidal/Version.hs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import Paths_tidal
-}

tidal_version :: String
tidal_version = "1.9.4"
tidal_version = "1.9.5"

tidal_status :: IO ()
tidal_status = tidal_status_string >>= putStrLn
Expand Down
2 changes: 1 addition & 1 deletion tidal-link/tidal-link.cabal
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
cabal-version: 2.4
name: tidal-link
version: 1.0.2
version: 1.0.3
synopsis: Ableton Link integration for Tidal
-- description:
homepage: http://tidalcycles.org/
Expand Down
4 changes: 2 additions & 2 deletions tidal.cabal
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
cabal-version: 2.0

name: tidal
version: 1.9.4
version: 1.9.5
synopsis: Pattern language for improvised music
description: Tidal is a domain specific language for live coding patterns.
homepage: http://tidalcycles.org/
Expand Down Expand Up @@ -67,7 +67,7 @@ library
, random < 1.3
, exceptions < 0.11
, mtl >= 2.2
, tidal-link == 1.0.2
, tidal-link == 1.0.3

test-suite tests
type: exitcode-stdio-1.0
Expand Down

0 comments on commit 88f09ed

Please sign in to comment.