Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

resultflow: 0.1.0 #60

Merged
merged 4 commits into from
Aug 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,11 @@ jobs:
run: |
tag=${GITHUB_REF#refs/tags/}
module=$(./scripts/get-module-name.sh "$tag")
module_path=${module#:}
module_path=${module_path//://}
echo "module=$module" >> "$GITHUB_OUTPUT"
echo "module_path=$module_path" >> "$GITHUB_OUTPUT"
echo "name=${tag/-v/ }" >> "$GITHUB_OUTPUT"

- name: Setup Gradle
uses: gradle/actions/setup-gradle@v3
Expand All @@ -68,3 +72,15 @@ jobs:
ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_KEY_PASSWORD }}
ORG_GRADLE_PROJECT_githubPackagesUsername: ${{ github.actor }}
ORG_GRADLE_PROJECT_githubPackagesPassword: ${{ secrets.GITHUB_TOKEN }}

- name: Extract release notes
uses: ffurrer2/extract-release-notes@v2
with:
changelog_file: ${{ steps.parse-tag.outputs.module_path }}/CHANGELOG.md
release_notes_file: RELEASE_NOTES.md

- name: Create GitHub Release
uses: softprops/action-gh-release@v2
with:
name: ${{ steps.parse-tag.outputs.name }}
body_path: RELEASE_NOTES.md
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ Gears could be used together or alone.

### :gear: **[Gears](gears/)**

- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.gears/gears-compose?style=flat-square)][gears-compose] — A set of gears for Jetpack Compose
- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.gears/kotlin?style=flat-square)][gears-kotlin] — A set of gears for Kotlin
- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.gears/gears-compose?style=flat-square&label=gears-compose)][gears-compose] — A set of gears for Jetpack Compose
- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.gears/kotlin?style=flat-square&label=gears-kotlin)][gears-kotlin] — A set of gears for Kotlin

### :hammer_and_wrench: **[red_mad_robot Android KTX](ktx/)**

Expand All @@ -35,11 +35,11 @@ Gears could be used together or alone.

### :mag_right: **[ViewModelEvents](viewmodelevents/)**

- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.gears/kotlin?style=flat-square)][viewmodelevents-compose] - A set of extensions for dealing with ViewModelEvents inside `@Composable` functions
- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.gears/kotlin?style=flat-square)][viewmodelevents-flow] - An implementation of ViewModelEvents via `Flow`
- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.gears/kotlin?style=flat-square)][viewmodelevents-livedata] - An implementation of ViewModelEvents via `LiveData`
- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.gears/kotlin?style=flat-square&label=viewmodelevents-compose)][viewmodelevents-compose] A set of extensions for dealing with ViewModelEvents inside `@Composable` functions
- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.gears/kotlin?style=flat-square&label=viewmodelevents-flow)][viewmodelevents-flow] An implementation of ViewModelEvents via `Flow`
- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.gears/kotlin?style=flat-square&label=viewmodelevents-livedata)][viewmodelevents-livedata] An implementation of ViewModelEvents via `LiveData`

### :hourglass_flowing_sand: **[Result Flow](resultflow/)** [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.gears/resultflow?style=flat-square)]
### :hourglass_flowing_sand: **[Result Flow](resultflow/)** ![Version](https://img.shields.io/maven-central/v/com.redmadrobot.gears/resultflow?style=flat-square)

A couple of extensions to convert long operations into `Flow<Result<T>>`.

Expand Down
2 changes: 0 additions & 2 deletions release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,6 @@ if [[ "$input" != "yes" ]]; then
exit 0
fi



# 5. Push changes, trigger release on CI, and give a link to open PR
echo
echo "⏳ Pushing the changes to the remote repository..."
Expand Down
7 changes: 7 additions & 0 deletions resultflow/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
## Unreleased

- *No changes*

## [0.1.0] (2024-08-01)

Initial release


[0.1.0]: https://github.com/RedMadRobot/gears-android/compare/9ada4423...resultflow-v0.1.0
10 changes: 5 additions & 5 deletions resultflow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
[![Version](https://img.shields.io/maven-central/v/com.redmadrobot.gears/resultflow?style=flat-square)][mavenCentral]
[![License](https://img.shields.io/github/license/RedMadRobot/gears-android?style=flat-square)][license]

A couple of extensions to convert long operations into `Flow<Result<T>>`.
Allows handling such operations in functional way and provides single point to handle `Pending`, `Success` and `Failure` states.

---
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
Expand All @@ -14,9 +17,6 @@

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

A couple of extensions to convert long operations into `Flow<Result<T>>`.
Allows handling such operations in functional way and provides single point to handle `Pending`, `Success` and `Failure` states.

## Installation

Add the dependency:
Expand All @@ -27,7 +27,7 @@ repositories {
}

dependencies {
implementation("com.redmadrobot.gears:resultflow:<version>")
implementation("com.redmadrobot.gears:resultflow:0.1.0")
}
```

Expand Down Expand Up @@ -89,5 +89,5 @@ Merge requests are welcome.
For major changes, open an issue first to discuss what you would like to change.


[mavenCentral]: https://search.maven.org/artifact/com.redmadrobot.gears/resultflow
[mavenCentral]: https://central.sonatype.com/artifact/com.redmadrobot.gears/resultflow
[license]: ../LICENSE