Skip to content

Commit

Permalink
Add most recent PR to changelog and finish contributing instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewkaney committed Apr 6, 2024
1 parent 1f9d9a8 commit d80b501
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
6 changes: 4 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## 1.9.5 - Sashiko

### What's Changed
## 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
Expand All @@ -11,10 +11,12 @@
* 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
## 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

Expand Down
13 changes: 10 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,8 @@ To run up your changes locally, install Tidal with `cabal install`. To remove th

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

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:

Expand All @@ -105,8 +107,9 @@ First, you need to do the following:
## 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)**: Changing the version field
* **[CHANGELOG.md](https://github.com/tidalcycles/Tidal/blob/1.10-dev/CHANGELOG.md)**: Adding your new version at the top (you can copy the release notes from your draft GitHub release)
* **[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.

Expand All @@ -117,4 +120,8 @@ Push any final changes to the code, updating the following files:
* Run `cabal check` to check for any errors with the package metadata.
* Run `cabal sdist` to generate an archive for distribution.

## Upload releases
## 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!

0 comments on commit d80b501

Please sign in to comment.