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

JitPack での Gradle Task の暗黙的な依存関係によるビルドエラーを修正する #137

Merged
merged 7 commits into from
Aug 30, 2024

Conversation

zztkm
Copy link
Contributor

@zztkm zztkm commented Aug 29, 2024

  • [FIX] Gradle Task の暗黙的な依存関係によるビルドエラーを修正する
    • generateMetadataFileForSora-android-sdkPublication は暗黙的に sourcesJar に依存していた
    • このため、タスクの実行順序によってはビルドエラーが発生する状況になっており、kotlin 1.9 に上げたタイミングで問題が発現した
    • この問題に対処するために、generateMetadataFileForSora-android-sdkPublicationsourcesJar に依存していることを明示的に宣言した

JitPack のビルド結果:
https://jitpack.io/com/github/shiguredo/sora-android-sdk/feature~test-jitpack-build-2021.1-gd9c3776-542/build.log


This pull request addresses a build error caused by implicit dependencies between Gradle tasks in the sora-android-sdk project. The key change is the explicit declaration of a dependency to ensure proper task execution order.

Fixes for build errors:

  • CHANGES.md: Documented the fix for the build error caused by the implicit dependency of the generateMetadataFileForSora-android-sdkPublication task on sourcesJar. This error surfaced when upgrading to Kotlin 1.9.
  • sora-android-sdk/build.gradle: Added a task dependency to explicitly declare that generateMetadataFileForSora-android-sdkPublication depends on sourcesJar, preventing build errors on JitPack.

@zztkm zztkm changed the title JitPack でのビルドエラーを修正 JitPack での Gradle Task の暗黙的な依存関係によるビルドエラーを修正する Aug 30, 2024
@zztkm zztkm requested a review from miosakuma August 30, 2024 01:57
@zztkm zztkm marked this pull request as ready for review August 30, 2024 01:57
- `generateMetadataFileForSora-android-sdkPublication` は暗黙的に `sourcesJar` に依存していた
- このため、タスクの実行順序によってはビルドエラーが発生する状況になっており、kotlin 1.9 に上げたタイミングで問題が発現した
- この問題に対処するために、`generateMetadataFileForSora-android-sdkPublication` が `sourcesJar` に依存していることを明示的に宣言した
- @zztkm
Copy link
Contributor

@miosakuma miosakuma Aug 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JitPack 上で起きたことを追記しました。
暗黙的に、という部分がうまく理解できていないのですが、以下のような理解であっているでしょうか?

- [FIX] JitPack で発生した Gradle Task の依存関係によるビルドエラーを修正する
  - Gradle Task `generateMetadataFileForSora-android-sdkPublication` は `sourcesJar` に依存しているが明示的な依存関係が指定されていなかった
  - このため、タスクの実行順序によってはビルドエラーが発生する状況が潜在しており、kotlin 1.9 に上げたタイミングで問題が発現した
  - この問題に対処するために、`generateMetadataFileForSora-android-sdkPublication` が `sourcesJar` に依存していることを明示的に宣言した

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JitPack の部分は 058e0c2 で修正しました

@@ -125,6 +125,16 @@ task sourcesJar(type: Jar) {
from android.sourceSets.main.java.srcDirs
}

tasks.whenTaskAdded { task ->
// kotlin 1.9 に上げたタイミングで、generateMetadataFileForSora-android-sdkPublication が
Copy link
Contributor

@miosakuma miosakuma Aug 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

先に JitPack があると、環境によることがわかってよいかと思いました。

   // kotlin 1.9 に上げたタイミングで、JitPack で generateMetadataFileForSora-android-sdkPublication が
    // sourcesJar より先に実行されるようになってしまいビルドエラーが発生した。

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

058e0c2 で修正しました

Copy link
Contributor

@miosakuma miosakuma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

対応ありがとうございます、無事 JitPack でビルドが通ることを確認できました!

@zztkm zztkm merged commit 0b063ba into develop Aug 30, 2024
1 check passed
@zztkm zztkm deleted the feature/fix-jitpack-build branch August 30, 2024 05:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants