47degrees / hood Goto Github PK

Currently the project is lacking a license.

I think we should include it to let people know if and how they can use/reuse Hood's code.

Add the ability to exclude certain keys from the Benchmarks and ignore them across the process or include some specific keys to take care of

This issue collects all the necessary tasks before hood release.

Blocking

• Fix SBT home button

Maybe blocking

• Delete footer Documentation link going to Gradle doc. Also github link leads to Gradle project.
• Add selector on top bar Documentation (to choose between sbt and Gradle) or delete it too. Also for Github link.
• Same problem with Learn more 3 section buttons.
  Suggestion: unify both microsites into a single one, maybe in a next iteration?

Non bloking

• Fix gradle urls so it goes to hood/gradle instead of hood/docs.
• Change sbt urls to goes from hood/sbt-hoot to hood/sbt (this involves changes in the sbt-hood microsite if we choose that road).
• Delete Hood home button on the sbt side and make top left icon redirecting properly (would imply changes in sbt-microsite templates).

We need to add the feature of continue even if we found an inconsistency between the benchmarks, logging a warning if it's found and compare only the common rows

Existing Bintray users are granted deploy permissions to relevant folders in Artifactory, according to the Maven Group ID of the packages they build. However, it's necessary to enable it:

• https://www.jfrog.com/confluence/display/RTF/Deploying+Snapshots+to+oss.jfrog.org > Getting Started with OJO

Please, could you check it? Reason: current failure when trying to deploy the SNAPSHOT.

In order to give support to jmh-visualizer we want to add the ability of print on the result on Json too

Context

This issue comes from a conversation with awesome @AdrianRaFo 🙌 We published a plugin for Arrow Meta in Gradle Plugin Portal though it's not available now because we removed it to wait for a release version.

Advantages

• Allow to use the released plugin with the plugins DSL instead of the legacy plugin application.
• Have all the 47 Degrees Gradle Plugins in a page: https://plugins.gradle.org/u/47degci

Steps

1. Have a Gradle account

@franciscodr created an account for 47Deg: https://plugins.gradle.org/u/47degci That account has a gradle.publish.key and gradle.publish.secret.

2. Create the secrets

• GRADLE_PUBLISH_KEY
• GRADLE_PUBLISH_SECRET

3. Configuration

Configure plugins, gradlePlugin and pluginBundle in build.gradle.

For instance: https://github.com/arrow-kt/arrow-meta/blob/master/gradle-plugin/build.gradle

4. Publish the plugin

Step for GitHub actions:

- name: Publish Gradle Plugin
  env:
    GRADLE_PUBLISH_KEY: ${{ secrets.GRADLE_PUBLISH_KEY }}
    GRADLE_PUBLISH_SECRET: ${{ secrets.GRADLE_PUBLISH_SECRET }}
  run: |
    ./gradlew -Dgradle.publish.key=$GRADLE_PUBLISH_KEY -Dgradle.publish.secret=$GRADLE_PUBLISH_SECRET publishPlugins

The first time, publish action will create a request for The Gradle team. The console output will be something like:

Publishing plugin XXX version XXX
Thank you. Your new plugin XXX has been submitted for approval
by Gradle engineers. 
The request should be processed within the next 24 hours, at which point
you will be contacted via email.

When it's approved, an email with the subject [Gradle] Plugin approved will be received and the plugin will appear in the Portal. And then, all the necessary versions will be able to be published without approval.

Links

• The guide that I followed: https://guides.gradle.org/publishing-plugins-to-gradle-plugin-portal/
• Gradle Plugin Portal: https://plugins.gradle.org/

Add a label on readme about the current version on bintray and create a GitHub tag for last release

The comparison result comments need a pretty markdown format.
Current comment example:

Decoding
master_benchmark | 18256.380327
helios_benchmark | 19236.258238
*** decoding looks good ***

Parsing
master_benchmark | 30330.45782
helios_benchmark | 31806.3492
*** parsing looks good ***

The compareBenchmark task should fail if the benchmark comparison has bad results master < branch so we could use it when the CI task is not available

We need to follow these steps https://plugins.gradle.org/docs/submit to include Hood on the Gradle plugin search tool

Proposal

Make status creation configurable.

Reason

• It adds an status to the commit which triggers the pull request and that commit already has the status by the check execution.
• It makes Hood fail with pull requests that are created from forked repositories:
  • Example with Travis: 47degrees/helios#139
  • Example with GitHub Actions: arrow-kt/arrow-incubator#54

We need a poster.png file for the microsite metadata for both Hood and SBT-hood microsites.

We should bring the possibility of sending the output result also to a file

We successfully publish releases but there is an error with the snapshot publish process

Reference: https://travis-ci.org/47deg/hood/builds/498685366