Add a global JSON index file inside Multi-language Rules Specification archive

[jycr]

Updates dependencies and adds a index.json file into the global (all languages) JAR file.

This index file contains:

• rule metadata by rule key for each language
• in the metadata of each rule:
  • adds the path to the HTML description file
  • extracts the terms from the HTML description (this will facilitate text searches)

By default, main branch and tags are published to GitHub Pages:
https://green-code-initiative.github.io/creedengo-rules-specifications/

Closes #301

[utarwyn]

Thanks for the code suggestion, it'll be very useful in case I can't put my idea of a stand-alone tool into practice. I'd love not to have to throw away my work done in #303.

First I need to update the JSON format and the website mock-up with your feedback on the possibilities for structuring the rules.

[jycr]

First I need to update the JSON format and the website mock-up with your feedback on the possibilities for structuring the rules.

You can see needed updates on website in this commit : jycr/green-code-initiative-website@7ee4316

[utarwyn]

We can also use the "GitHub action" approach to reduce complexity in this workflow. Check the official doc here.

[jycr]

In all transparency, I'm completely new to GitHub Actions.

My proposal is therefore very much open to improvement.

Please feel free to suggest concrete improvements by adding commits directly to this branch.

[utarwyn]

Won't the build folder name be perceived by contributors as a folder with generated files?

[jycr]

You're right. What name would you suggest? As far as I know, there is no convention for naming the directory that should contain resources used only by the build process itself.

[dedece35]

I let @utarwyn do the review because he knows very well this part of system.

[sonarqubecloud]

Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

[utarwyn]

Following our discussion, I propose to keep only the JShell migration in this PR. The generation of the rules JSON file will be dealt with in #303

[github-actions]

This PR has been automatically marked as stale because it has no activity for 60 days.
Please add a comment if you want to keep the issue open. Thank you for your contributions!