Skip to content

Commit

Permalink
Add instructions to quickly test changes in the extractor
Browse files Browse the repository at this point in the history
- Make use of the local Maven repository
  • Loading branch information
mauriciocolli committed Oct 28, 2019
1 parent e33bbd8 commit 853218c
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,17 @@ If you're using Gradle, you could add NewPipe Extractor as a dependency with the
1. Add `maven { url 'https://jitpack.io' }` to the `repositories` in your `build.gradle`.
2. Add `compile 'com.github.TeamNewPipe:NewPipeExtractor:v0.11.0'`the `dependencies` in your `build.gradle`. Replace `v0.11.0` with the latest release.

### Testing changes

To test changes quickly you can build the library locally. Using the local Maven repository is a good approach, here's a gist of how to use it:

1. Add `mavenLocal()` in your project `repositories` list (usually as the first entry to give priority above the others).
2. It's _recommended_ that you change the `version` of this library (e.g. `LOCAL_SNAPSHOT`).
3. Run gradle's `ìnstall` task to deploy this library to your local repository (using the wrapper, present in the root of this project: `./gradlew install`)
4. Change the dependency version used in your project to match the one you chose in step 2 (`implementation 'com.github.TeamNewPipe:NewPipeExtractor:LOCAL_SNAPSHOT'`)

> Tip for Android Studio users: After you make changes and run the `install` task, use the menu option `File → "Sync with File System"` to refresh the library in your project.
## Supported sites

The following sites are currently supported:
Expand Down
8 changes: 8 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -1,15 +1,23 @@
allprojects {
apply plugin: 'java-library'
apply plugin: 'maven'

sourceCompatibility = 1.7
targetCompatibility = 1.7

version 'v0.13.0'
group 'com.github.TeamNewPipe'

repositories {
jcenter()
}
}

dependencies {
implementation project(':extractor')
implementation project(':timeago-parser')
}

subprojects {
task sourcesJar(type: Jar, dependsOn: classes) {
classifier = 'sources'
Expand Down

0 comments on commit 853218c

Please sign in to comment.