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

[#503] Deprecate the XML template #519

Merged
merged 11 commits into from
Oct 16, 2023

Conversation

thiennguyen0196
Copy link
Contributor

@thiennguyen0196 thiennguyen0196 commented Sep 14, 2023

#503

What happened 👀

  • Create folder deprecated
  • Move template-xml RxJavaTemplate sample-xml into the deprecated folder
  • Rename RxJavaTemplate[DEPRECATED] into simply RxJavaTemplate because it has already been moved into deprecated folder
  • Edit file README to replace all xml places by compose
  • Update CI workflow, add the prefix deprecated into the link to folder template-xml sample-xml ....
  • Update script to remove generating XML project script, also the template key as optional and its default value is compose
  • Remove gradle/wrapper folder and `gradle-wrapper.properties

Insight 📝

N/A

Proof Of Work 📹

  • The repository has deprecated folder which contains template-xml sample-xml RxJavaTemplate
Screenshot 2023-10-09 at 3 59 09 PM
  • The README file was changed from xml to compose
Screenshot 2023-10-13 at 3 00 13 PM

@github-actions
Copy link

github-actions bot commented Sep 14, 2023

12 Warnings
⚠️ Uh oh! ApiServiceProvider.kt is under 95% coverage!
⚠️ Uh oh! BaseSharedPreferences.kt is under 95% coverage!
⚠️ Uh oh! BaseViewModel.kt is under 95% coverage!
⚠️ Uh oh! ConverterFactoryProvider.kt is under 95% coverage!
⚠️ Uh oh! DispatchersProviderImpl.kt is under 95% coverage!
⚠️ Uh oh! EncryptedSharedPreferences.kt is under 95% coverage!
⚠️ Uh oh! ErrorMapping.kt is under 95% coverage!
⚠️ Uh oh! ResponseMapping.kt is under 95% coverage!
⚠️ Uh oh! RetrofitProvider.kt is under 95% coverage!
⚠️ Uh oh! SharedPreferencesExt.kt is under 95% coverage!
⚠️ Uh oh! UiModel.kt is under 95% coverage!
⚠️ Uh oh! Your project is under 80% coverage!

Kover report for template-compose:

🧛 Template - Compose Unit Tests Code Coverage: 62.05%

Coverage of Modified Files:

File Coverage
ApiServiceProvider.kt 0.00%
AppPreferencesRepositoryImpl.kt 100.00%
BaseSharedPreferences.kt 0.00%
BaseViewModel.kt 73.91%
ConverterFactoryProvider.kt 0.00%
DispatchersProviderImpl.kt 0.00%
EncryptedSharedPreferences.kt 0.00%
Error.kt 100.00%
ErrorMapping.kt 68.75%
ErrorResponse.kt 100.00%
Exceptions.kt 100.00%
HomeViewModel.kt 100.00%
MainActivity.kt 100.00%
MainApplication.kt 100.00%
Model.kt 100.00%
MoshiBuilderProvider.kt 100.00%
RepositoryImpl.kt 100.00%
Response.kt 100.00%
ResponseMapping.kt 90.85%
RetrofitProvider.kt 0.00%
SharedPreferencesExt.kt 0.00%
UiModel.kt 84.21%
UseCase.kt 100.00%

Modified Files Not Found In Coverage Report:

.gitignore
.gitignore
.gitignore
.gitignore
.gitignore
.gitignore
.gitignore
.gitignore
.gitignore
.gitignore
.gitignore
.gitignore
.gitignore
.gitignore
.gitignore
.gitignore
Alias.kt
AndroidManifest.xml
AndroidManifest.xml
AndroidManifest.xml
AndroidManifest.xml
AndroidManifest.xml
AndroidManifest.xml
AndroidManifest.xml
AndroidManifest.xml
AndroidManifest.xml
AndroidManifest.xml
ApiConst.kt
ApiEndpointUrl.kt
ApiEndpointUrlImpl.kt
ApiEndpointUrlImpl.kt
ApiRepository.kt
ApiRepositoryTest.kt
ApiService.kt
ApiService.kt
ApiService.kt
ApiServiceTest.kt
AppError.kt
AppFlowTest.kt
AppModule.kt
AppModule.kt
AppModule.kt
AppPreferencesRepository.kt
AppPreferencesRepository.kt
AppPreferencesRepositoryImplTest.kt
AppPreferencesRepositoryImplTest.kt
AppRequestInterceptor.kt
AppWebChromeClient.kt
Appfile
BaseActivity.kt
BaseActivity.kt
BaseActivity.kt
BaseFragment.kt
BaseFragment.kt
BaseFragment.kt
BaseFragmentCallbacks.kt
BaseFragmentCallbacks.kt
BaseFragmentCallbacks.kt
BaseFragmentTest.kt
BaseFragmentTest.kt
BaseFragmentTest.kt
BaseNavigator.kt
BaseNavigator.kt
BaseNavigator.kt
BaseUseCase.kt
ClientId.kt
ClientIdImpl.kt
ClientIdImpl.kt
ClientSecret.kt
ClientSecretImpl.kt
ClientSecretImpl.kt
CompletableUseCase.kt
Configurations.kt
Configurations.kt
Configurations.kt
Const.kt
Dangerfile
Data.kt
DataAdapter.kt
DataError.kt
DispatchersProvider.kt
DispatchersProvider.kt
EmptyHiltActivity.kt
EmptyHiltActivity.kt
EmptyHiltActivity.kt
ExampleApiRequest.kt
ExampleApiResponse.kt
Fastfile
FileExt.kt
FileExt.kt
FileExt.kt
FlowableNeverErrorTransformer.kt
FlowableUseCase.kt
FragmentComponentsModule.kt
Gemfile
Gemfile.lock
GetExampleDataUseCase.kt
GetExampleDataUseCaseTest.kt
GetModelsUseCase.kt
GetModelsUseCaseTest.kt
GlideModule.kt
Home.kt
HomeFragment.kt
HomeFragment.kt
HomeFragment.kt
HomeFragmentTest.kt
HomeFragmentTest.kt
HomeFragmentTest.kt
HomeViewModelTest.kt
ImageTransformation.kt
ImageViewExtension.kt
IsFirstTimeLaunchPreferencesUseCase.kt
IsFirstTimeLaunchPreferencesUseCaseTest.kt
ItemClickable.kt
ItemListAdapter.kt
KeywordExtension.kt
KeywordExtensionKtTest.kt
MainActivityModule.kt
MainActivityModule.kt
MainNavigator.kt
MainNavigator.kt
MainNavigator.kt
MainNavigatorTest.kt
MainViewModel.kt
MainViewModel.kt
MainViewModel.kt
MockUtil.kt
MockUtil.kt
MockUtil.kt
MoshiModule.kt
MoshiModule.kt
MoshiModule.kt
NavArgsExt.kt
NavArgsExt.kt
NavArgsExt.kt
NavArgsExt.kt
NavigationError.kt
NavigationEvent.kt
NavigationEvent.kt
NavigationEvent.kt
NavigationException.kt
NavigationException.kt
NavigatorModule.kt
NavigatorModule.kt
NormalSharedPreferences.kt
ObservableExt.kt
OkHttpClientModule.kt
OkHttpClientModule.kt
OkHttpClientModule.kt
Optional.kt
Pluginfile
PreferencesModule.kt
PreferencesModule.kt
README.md
README.md
README.md
README.md
README.md
Repository.kt
Repository.kt
RepositoryModule.kt
RepositoryModule.kt
RepositoryModule.kt
RepositoryTest.kt
RepositoryTest.kt
ResponseMappingTest.kt
ResponseMappingTest.kt
ResponseMappingTest.kt
RetrofitModule.kt
RetrofitModule.kt
RetrofitModule.kt
RxJavaExtension.kt
RxJavaTemplateApplication.kt
RxViewExt.kt
SchedulerProvider.kt
Second.kt
SecondBundle.kt
SecondFragment.kt
SecondFragment.kt
SecondFragmentTest.kt
SecondFragmentTest.kt
SecondFragmentUnitTest.kt
SecondViewModel.kt
SecondViewModel.kt
SecondViewModelTest.kt
Secrets.kt
SharePreferencesExt.kt
SingleUseCase.kt
StorageModule.kt
StorageModule.kt
StorageModule.kt
SupportEdge2EdgeHelper.kt
TakeWhenTransformer.kt
TestApiRepositoryImpl.kt
TestModules.kt
TestModules.kt
TestModules.kt
TestRepositoryModule.kt
TestRunner.kt
TestUtil.kt
Toaster.kt
Toaster.kt
Toaster.kt
Transformers.kt
TypeAlias.kt
TypeAlias.kt
UpdateFirstTimeLaunchPreferencesUseCase.kt
UpdateFirstTimeLaunchPreferencesUseCaseTest.kt
UseCaseTest.kt
ValidateError.kt
Versions.kt
Versions.kt
Versions.kt
ViewModelExt.kt
ViewModelExt.kt
ViewModelExt.kt
ViewModelExt.kt
ViewModelExt.kt
ViewModelExt.kt
ViewModelFactory.kt
WebView.kt
WebViewBundle.kt
WebViewExt.kt
WebViewFragment.kt
WebViewFragmentTest.kt
WebViewViewModel.kt
WebViewViewModelTest.kt
activity_main.xml
activity_main.xml
activity_main.xml
build.gradle.kts
build.gradle.kts
build.gradle.kts
build.gradle.kts
build.gradle.kts
build.gradle.kts
build.gradle.kts
build.gradle.kts
build.gradle.kts
build.gradle.kts
build.gradle.kts
build.gradle.kts
build.gradle.kts
build.gradle.kts
build.gradle.kts
build.gradle.kts
build.rb
checkstyle-custom.xsl
checkstyle.xml
circularstd_bold.otf
circularstd_book.otf
codemagic.yaml
codequality.gradle.kts
colors.xml
colors.xml
colors.xml
colors.xml
colors.xml
colors_pallete.xml
config.rb
debug.keystore
debug.keystore
detekt-config.yml
detekt-config.yml
detekt-config.yml
dimens.xml
dimens.xml
dimens_text.xml
fragment_home.xml
fragment_home.xml
fragment_home.xml
fragment_second.xml
fragment_second.xml
fragment_webview.xml
gradle-wrapper.jar
gradle-wrapper.jar
gradle-wrapper.jar
gradle-wrapper.properties
gradle-wrapper.properties
gradle-wrapper.properties
gradle.properties
gradle.properties
gradle.properties
gradlew
gradlew
gradlew
gradlew.bat
gradlew.bat
gradlew.bat
ic_launcher.png
ic_launcher.png
ic_launcher.png
ic_launcher.png
ic_launcher.png
ic_launcher.png
ic_launcher.png
ic_launcher.png
ic_launcher.png
ic_launcher.png
ic_launcher.png
ic_launcher.png
ic_launcher.png
ic_launcher.png
ic_launcher.png
ic_launcher.xml
ic_launcher.xml
ic_launcher.xml
ic_launcher_background.xml
ic_launcher_background.xml
ic_launcher_background.xml
ic_launcher_foreground.xml
ic_launcher_foreground.xml
ic_launcher_foreground.xml
ic_launcher_round.png
ic_launcher_round.png
ic_launcher_round.png
ic_launcher_round.png
ic_launcher_round.png
ic_launcher_round.png
ic_launcher_round.png
ic_launcher_round.png
ic_launcher_round.png
ic_launcher_round.png
ic_launcher_round.png
ic_launcher_round.png
ic_launcher_round.png
ic_launcher_round.png
ic_launcher_round.png
ic_launcher_round.xml
ic_launcher_round.xml
ic_launcher_round.xml
item_data.xml
item_home_list.xml
jacoco.gradle.kts
nav_graph_main.xml
nav_graph_main.xml
nav_graph_main.xml
network_security_config.xml
network_security_config.xml
network_security_config.xml
network_security_config.xml
network_security_config.xml
network_security_config.xml
new_project.kts
org.mockito.plugins.MockMaker
proguard-rules.pro
proguard-rules.pro
proguard-rules.pro
proguard-rules.pro
proguard-rules.pro
proguard-rules.pro
proguard-rules.pro
review_pull_request.yml
robolectric.properties
robolectric.properties
robolectric.properties
run_detekt_and_unit_tests.yml
settings.gradle.kts
settings.gradle.kts
settings.gradle.kts
signing.properties
signing.properties
signing.properties
strings.xml
strings.xml
strings.xml
strings.xml
strings.xml
strings.xml
strings.xml
strings_tokens_and_keys.xml
styles.xml
styles.xml
styles.xml
verify_newproject_script.yml
view_loading.xml
widget_styles.xml

Codebase cunningly covered by count Shroud 🧛

Generated by 🚫 Danger

@thiennguyen0196 thiennguyen0196 temporarily deployed to template-compose September 14, 2023 10:55 — with GitHub Actions Inactive
@thiennguyen0196 thiennguyen0196 temporarily deployed to template-compose September 14, 2023 16:40 — with GitHub Actions Inactive
@thiennguyen0196 thiennguyen0196 temporarily deployed to template-compose September 14, 2023 16:41 — with GitHub Actions Inactive
@thiennguyen0196 thiennguyen0196 temporarily deployed to template-compose September 14, 2023 16:42 — with GitHub Actions Inactive
Copy link
Member

@luongvo luongvo left a comment

Choose a reason for hiding this comment

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

Another question: do we need to keep these gradle stuff at root?

image

.github/workflows/review_pull_request.yml Outdated Show resolved Hide resolved
.github/workflows/run_detekt_and_unit_tests.yml Outdated Show resolved Hide resolved
.github/workflows/run_detekt_and_unit_tests.yml Outdated Show resolved Hide resolved
Dangerfile Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
codemagic.yaml Outdated Show resolved Hide resolved
codemagic.yaml Outdated Show resolved Hide resolved
codemagic.yaml Outdated Show resolved Hide resolved
deprecated/RxJavaTemplate[DEPRECATED]/.gitignore Outdated Show resolved Hide resolved
.github/workflows/review_pull_request.yml Show resolved Hide resolved
@thiennguyen0196 thiennguyen0196 temporarily deployed to template-compose October 9, 2023 09:03 — with GitHub Actions Inactive
@thiennguyen0196
Copy link
Contributor Author

Resolved and updated the description @luongvo

@thiennguyen0196 thiennguyen0196 temporarily deployed to template-compose October 9, 2023 09:20 — with GitHub Actions Inactive
Copy link
Collaborator

@ryan-conway ryan-conway left a comment

Choose a reason for hiding this comment

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

The rest LGTM 🙏🏻

.github/workflows/verify_newproject_script.yml Outdated Show resolved Hide resolved
scripts/new_project.kts Outdated Show resolved Hide resolved
scripts/new_project.kts Show resolved Hide resolved
Copy link
Member

@luongvo luongvo left a comment

Choose a reason for hiding this comment

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

The rest lgtm

gradle/wrapper/gradle-wrapper.properties Outdated Show resolved Hide resolved
.github/workflows/verify_newproject_script.yml Outdated Show resolved Hide resolved
@thiennguyen0196 thiennguyen0196 force-pushed the chore/503-deprecate-xml-template branch from a66ed41 to 10e01c3 Compare October 13, 2023 07:35
@thiennguyen0196 thiennguyen0196 temporarily deployed to template-compose October 13, 2023 07:35 — with GitHub Actions Inactive
@thiennguyen0196 thiennguyen0196 temporarily deployed to template-compose October 13, 2023 07:36 — with GitHub Actions Inactive
@thiennguyen0196 thiennguyen0196 temporarily deployed to template-compose October 13, 2023 08:01 — with GitHub Actions Inactive
@thiennguyen0196 thiennguyen0196 temporarily deployed to template-compose October 13, 2023 08:02 — with GitHub Actions Inactive
@thiennguyen0196
Copy link
Contributor Author

Updated all @ryan-conway @luongvo

Copy link
Member

@luongvo luongvo left a comment

Choose a reason for hiding this comment

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

LGTM now

@ryan-conway ryan-conway merged commit ce05d6b into develop Oct 16, 2023
@ryan-conway ryan-conway deleted the chore/503-deprecate-xml-template branch October 16, 2023 03:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deprecate the XML template
7 participants