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

Update README to use JitPack for addons #1446

Merged
merged 3 commits into from
Aug 23, 2018
Merged

Conversation

eyesniper2
Copy link
Contributor

Target Minecraft versions: N/A
Requirements: N/A
Related issues: N/A

Description:
This is an update to the README in order to move addon developers away from using the GitHub Maven repo and to instead use JitPack. Right now the GitHub Maven repo requires manual updates and doesn't have dev37. Changing to JitPack will remove the need for manual updates and will instead automatically update.

maven {
url 'https://raw.githubusercontent.com/bensku/mvn-repo/master'
First, you need to add the JitPack repository at the **END** of all your repositories. Skript is not available in Maven Central.
```gradle

Choose a reason for hiding this comment

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

Just put the repository declaration here and mention that it belongs to the repositories block.

If that seems too vague for you, just link them to the Gradle user guide since they should know where it goes already.

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 recommends adding its repository at the end which is why I included that instruction.

Note: when using multiple repositories in build.gradle it is recommended to add JitPack at the end. Gradle will go through all repositories in order until it finds a dependency.

https://jitpack.io/docs/#building-with-jitpack

Copy link
Member

Choose a reason for hiding this comment

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

Jitpack can be quite slow at times. If other repo can be used, that is probably a good idea.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

From my experience the speed of JitPack has been fine. The main issues I see with the current GitHub Repo as a Maven Repo is the extra work required to keep it up to date. Using JitPack removes that extra work, allowing addon developers to always use the latest version of Skript to build.

Choose a reason for hiding this comment

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

Personally, Jitpack has never been slow to me, and I use it frequently. We're better off just merging this (thing that I already did) and change it if someone happens to have this issue.

@Nicofisi Nicofisi added the enhancement Feature request, an issue about something that could be improved, or a PR improving something. label Aug 6, 2018
Copy link
Member

@Nicofisi Nicofisi left a comment

Choose a reason for hiding this comment

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

IMHO it should be capitalized as com.github.skriptlang:skript:[versionTag], but looks good otherwise

@Snow-Pyon Snow-Pyon merged commit 2caf579 into SkriptLang:master Aug 23, 2018
@Snow-Pyon
Copy link

Thanks for the contribution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Feature request, an issue about something that could be improved, or a PR improving something.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants