https://github.com/bastian/bstats-metrics

The different bStats Metrics classes
https://github.com/bastian/bstats-metrics

bstats bukkit bungeecord hacktoberfest metrics minecraft spigot sponge

Last synced: 6 days ago
JSON representation

The different bStats Metrics classes

• Host: GitHub
• URL: https://github.com/bastian/bstats-metrics
• Owner: Bastian
• License: mit
• Created: 2017-02-17T09:59:56.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-09-22T17:51:29.000Z (4 months ago)
• Last Synced: 2024-12-28T18:04:27.141Z (13 days ago)
• Topics: bstats, bukkit, bungeecord, hacktoberfest, metrics, minecraft, spigot, sponge
• Language: Java
• Homepage: https://bStats.org
• Size: 383 KB
• Stars: 100
• Watchers: 11
• Forks: 114
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# bStats Java Metrics Classes

This repository contains the code for all Java-based Metrics classes.

## Code Generation

The recommended way to include the Metrics classes is to use a build management tool like Gradle or Maven and

shade + relocate the required classes.

However, to make bStats more accessible for beginners, a single file Metrics class is automatically generated on every

release and pushed to the `single-file` branch. This file can simply be copy-and-pasted.

To generate a Metrics class locally, you can run the `gradlew generateMetrics` command.

It will write the generated files into the `/build/generated/` directory.

## Publishing

Snapshots are automatically published on every push.

To publish a new release, one can simply remove the `-SNAPSHOT` suffix from the version in the `gradle.properties` file

and in the [`MetricsBase`](/base/src/main/java/org/bstats/MetricsBase.java) class.

This will automatically trigger a GitHub Action that

* Publishes a GitHub Release

* Pushes the new version to Maven Central

* Creates and pushes a new commit that updates the version by one patch level and append a `-SNAPSHOT` suffix (e.g., `2.3.4` -> `2.3.5-SNAPSHOT`).

## GitHub Action Secrets

For the GitHub Actions to properly work, one must configure the following [encrypted secrets](https://docs.github.com/en/actions/reference/encrypted-secrets):

* `OSSRH_USERNAME`: The username used to publish the Maven Central

* `OSSRH_TOKEN`: The password used to publish to Maven Central

* `SIGNING_KEY`: The PGP private key used to sign the built artifacts (can be obtained by running `gpg --export-secret-keys -a  > key.txt`)

* `SIGNING_PASSWORD`: The passphrase that protects the private key