Skip to content
This repository has been archived by the owner on Feb 5, 2021. It is now read-only.

Commit

Permalink
Releasing v0.29.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
zach-klippenstein committed May 18, 2020
1 parent a58aafe commit eb8a3d0
Show file tree
Hide file tree
Showing 3 changed files with 120 additions and 1 deletion.
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Change Log
==========

Version 0.29.0
--------------

_2020-05-18_

* First release from separate repo.
* Update: Compose version to dev11. (#26)
* New: Add the ability to display nested renderings with `bindCompose`. (#7)
* New: Introduce `ComposeWorkflow`, a self-rendering Workflow. (#8)
* New: Introduce tooling module with support for previewing ViewBindings with Compose's Preview. (#15)
* New: Introduce WorkflowContainer for running a workflow inside a Compose app. (#16)
* Breaking: Tidy up the package structure. (#23)
104 changes: 104 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
Releasing
=========

Production Releases
-------------------

1. Merge an update of [the change log](CHANGELOG.md) with the changes since the last release.

1. Make sure you're on the `master` branch (or fix branch, e.g. `v0.1-fixes`).

1. Confirm that the kotlin build is green before committing any changes
```bash
(cd kotlin && ./gradlew build connectedCheck)
```

1. In `kotlin/gradle.properties`, remove the `-SNAPSHOT` prefix from the `VERSION_NAME` property.
E.g. `VERSION_NAME=0.1.0`

1. Create a commit and tag the commit with the version number:
```bash
git commit -am "Releasing v0.1.0."
git tag v0.1.0
```

1. Upload the kotlin artifacts:
```bash
(cd kotlin && ./gradlew build && ./gradlew uploadArchives --no-parallel)
```

1. Close and release the staging repository at https://oss.sonatype.org.

1. Update the `VERSION_NAME` property in `kotlin/gradle.properties` to the new
snapshot version, e.g. `VERSION_NAME=0.2.0-SNAPSHOT`.

1. Commit the new snapshot version:
```
git commit -am "Finish releasing v0.1.0."
```

1. Push your commits and tag:
```
git push origin master
# or git push origin fix-branch
git push origin v0.1.0
```

1. Create the release on GitHub:
1. Go to the [Releases](https://github.com/square/workflow-kotlin-compose/releases) page for the GitHub
project.
1. Click "Draft a new release".
1. Enter the tag name you just pushed.
1. Title the release with the same name as the tag.
1. Copy & paste the changelog entry for this release into the description.
1. If this is a pre-release version, check the pre-release box.
1. Hit "Publish release".

1. If this was a fix release, merge changes to the master branch:
```bash
git checkout master
git pull
git merge --no-ff v0.1-fixes
# Resolve conflicts. Accept master's versions of gradle.properties and podspecs.
git push origin master
```

1. Publish the website. See below.

---

## Kotlin Notes

### Development

To build and install the current version to your local Maven repository (`~/.m2`), run:

```bash
./gradlew clean installArchives
```

### Deploying

#### Configuration

In order to deploy artifacts to a Maven repository, you'll need to set 4 properties in your private
Gradle properties file (`~/.gradle/gradle.properties`):

```
RELEASE_REPOSITORY_URL=<url of release repository>
SNAPSHOT_REPOSITORY_URL=<url of snapshot repository
SONATYPE_NEXUS_USERNAME=<username>
SONATYPE_NEXUS_PASSWORD=<password>
```

#### Snapshot Releases

Double-check that `gradle.properties` correctly contains the `-SNAPSHOT` suffix, then upload
snapshot artifacts to Sonatype just like you would for a production release:

```bash
./gradlew clean build && ./gradlew uploadArchives --no-parallel
```

You can verify the artifacts are available by visiting
https://oss.sonatype.org/content/repositories/snapshots/com/squareup/workflow/.
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ android.enableJetifier=true
systemProp.org.gradle.internal.publish.checksums.insecure=true

GROUP=com.squareup.workflow
VERSION_NAME=0.27.0-SNAPSHOT
VERSION_NAME=0.29.0

POM_DESCRIPTION=Reactive workflows

Expand Down

0 comments on commit eb8a3d0

Please sign in to comment.