Skip to content

Commit

Permalink
leventeBajczi -> ftsrg in badges and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@leventeBajczi
leventeBajczi committed Jul 11, 2023
1 parent 9c9f694 commit 58b4d90
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 23 deletions.
22 changes: 11 additions & 11 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Theta

![](https://raw.githubusercontent.com/leventeBajczi/theta/badges/badges/build-Linux/badge.svg)
![](https://raw.githubusercontent.com/leventeBajczi/theta/badges/badges/build-Windows/badge.svg)
![](https://raw.githubusercontent.com/leventeBajczi/theta/badges/badges/build-macOS/badge.svg)
![](https://raw.githubusercontent.com/leventeBajczi/theta/badges/badges/test-Linux/badge.svg)
![](https://raw.githubusercontent.com/leventeBajczi/theta/badges/badges/test-Windows/badge.svg)
![](https://raw.githubusercontent.com/leventeBajczi/theta/badges/badges/test-macOS/badge.svg)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=leventeBajczi_theta&metric=coverage)](https://sonarcloud.io/summary/new_code?id=leventeBajczi_theta)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=leventeBajczi_theta&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=leventeBajczi_theta)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=leventeBajczi_theta&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=leventeBajczi_theta)
[![Check copyright](https://github.com/leventeBajczi/theta/actions/workflows/check-copyright.yml/badge.svg)](https://github.com/leventeBajczi/theta/actions/workflows/check-copyright.yml)
[![Check formatting](https://github.com/leventeBajczi/theta/actions/workflows/check-formatting.yml/badge.svg)](https://github.com/leventeBajczi/theta/actions/workflows/check-formatting.yml)
![](https://raw.githubusercontent.com/ftsrg/theta/badges/badges/build-Linux/badge.svg)
![](https://raw.githubusercontent.com/ftsrg/theta/badges/badges/build-Windows/badge.svg)
![](https://raw.githubusercontent.com/ftsrg/theta/badges/badges/build-macOS/badge.svg)
![](https://raw.githubusercontent.com/ftsrg/theta/badges/badges/test-Linux/badge.svg)
![](https://raw.githubusercontent.com/ftsrg/theta/badges/badges/test-Windows/badge.svg)
![](https://raw.githubusercontent.com/ftsrg/theta/badges/badges/test-macOS/badge.svg)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=ftsrg_theta&metric=coverage)](https://sonarcloud.io/summary/new_code?id=ftsrg_theta)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=ftsrg_theta&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=ftsrg_theta)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ftsrg_theta&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=ftsrg_theta)
[![Check copyright](https://github.com/ftsrg/theta/actions/workflows/check-copyright.yml/badge.svg)](https://github.com/ftsrg/theta/actions/workflows/check-copyright.yml)
[![Check formatting](https://github.com/ftsrg/theta/actions/workflows/check-formatting.yml/badge.svg)](https://github.com/ftsrg/theta/actions/workflows/check-formatting.yml)
[![Apache 2.0 License](https://img.shields.io/badge/license-Apache--2-brightgreen.svg?style=flat)](https://www.apache.org/licenses/LICENSE-2.0)

![Theta logo](doc/theta-logo.png)
Expand Down
4 changes: 2 additions & 2 deletions build.gradle.kts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ allprojects {

sonar {
properties {
property("sonar.projectKey", "leventeBajczi_theta")
property("sonar.organization", "bajczi-levente")
property("sonar.projectKey", "ftsrg_theta")
property("sonar.organization", "ftsrg-github")
property("sonar.host.url", "https://sonarcloud.io")
property("sonar.coverage.jacoco.xmlReportPaths", "${project.buildDir}/reports/jacoco/jacocoRootReport/jacocoRootReport.xml")
}
Expand Down
20 changes: 10 additions & 10 deletions doc/CI.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,20 @@ The `master` branch is protected, meaning direct pushes to the branch are forbid
* All conversations are marked _resolved_.
* The source is up-to-date with the destination.
* The following checks passed:
* License headers are present (and up-to-date) on all files (see [check-copyright.yml](todo))
* The style guide `ThetaIntelliJCodeStyle.xml` is applied to all files (see [check-formatting.yml](todo))
* SonarCloud check for code quality succeeds (see job `run-sonar` in [linux-build-test-deploy.yml](todo)), including test coverage criteria (at least 60% of the new code)
* Building and tests succeed for `ubuntu-latest` ([linux-build-test-deploy.yml](todo)), `windows-latest` ([win-build-test.yml](todo)) and `macos-latest` ([mac-build-test.yml](todo)).
* Valid javadoc can be generated (`javadoc` in [linux-build-test-deploy.yml](todo))
* The version must be different to that of `master` ([check-version.yml](todo)). For an automated version bump, see[version-bump.yml](todo).
* License headers are present (and up-to-date) on all files (see [check-copyright.yml](https://github.com/ftsrg/theta/actions/workflows/check-copyright.yml))
* The style guide `ThetaIntelliJCodeStyle.xml` is applied to all files (see [check-formatting.yml](https://github.com/ftsrg/theta/actions/workflows/check-formatting.yml))
* SonarCloud check for code quality succeeds (see job `run-sonar` in [linux-build-test-deploy.yml](https://github.com/ftsrg/theta/actions/workflows/linux-build-test-deploy.yml)), including test coverage criteria (at least 60% of the new code)
* Building and tests succeed for `ubuntu-latest` ([linux-build-test-deploy.yml](https://github.com/ftsrg/theta/actions/workflows/linux-build-test-deploy.yml)), `windows-latest` ([win-build-test.yml](https://github.com/ftsrg/theta/actions/workflows/win-build-test.yml)) and `macos-latest` ([mac-build-test.yml](https://github.com/ftsrg/theta/actions/workflows/mac-build-test.yml)).
* Valid javadoc can be generated (`javadoc` in [linux-build-test-deploy.yml](https://github.com/ftsrg/theta/actions/workflows/linux-build-test-deploy.yml))
* The version must be different to that of `master` ([check-version.yml](https://github.com/ftsrg/theta/actions/workflows/check-version.yml)). For an automated version bump, see[version-bump.yml](https://github.com/ftsrg/theta/actions/workflows/version-bump.yml).

Administrators are allowed to bypass these rules, but are strongly encouraged _not to do so_.

## Code style

Theta adopts (with small adjustments) the coding style of [Google](https://github.com/google/styleguide/blob/gh-pages/intellij-java-google-style.xml) via the `doc/ThetaIntelliJCodeStyle.xml` IntelliJ formatting file. Automatic reformatting of files can either be set up in [IDEA](https://www.jetbrains.com/help/idea/reformat-and-rearrange-code.html), or be done via the [reformat-code.yml](todo) manually launchable github action, with options for direct commit (not to master) or an automatically opened PR.
Theta adopts (with small adjustments) the coding style of [Google](https://github.com/google/styleguide/blob/gh-pages/intellij-java-google-style.xml) via the `doc/ThetaIntelliJCodeStyle.xml` IntelliJ formatting file. Automatic reformatting of files can either be set up in [IDEA](https://www.jetbrains.com/help/idea/reformat-and-rearrange-code.html), or be done via the [reformat-code.yml](https://github.com/ftsrg/theta/actions/workflows/reformat-code.yml) manually launchable github action, with options for direct commit (not to master) or an automatically opened PR.

Every file containing code should have the license header defined in `doc/copyright-header.txt`. This behavior can either be set up in [IDEA](https://www.jetbrains.com/help/idea/copyright.html), or be done via the [reapply_copyright.yml](todo) manually launchable github action, with options for direct commit (not to master) or an automatically opened PR.
Every file containing code should have the license header defined in `doc/copyright-header.txt`. This behavior can either be set up in [IDEA](https://www.jetbrains.com/help/idea/copyright.html), or be done via the [reapply_copyright.yml](https://github.com/ftsrg/theta/actions/workflows/reapply_copyright.yml) manually launchable github action, with options for direct commit (not to master) or an automatically opened PR.

Theta uses the [SonarCloud](https://sonarcloud.io/) tool for static analysis and code quality metrics. The current rules and quality gates are subject to change based on feedback.

Expand All @@ -35,6 +35,6 @@ For a more-or-less stable user experience, binaries are generated at stable mile
* GitHub releases (JARs, and source code)
* [Maven Central](https://central.sonatype.com/namespace/hu.bme.mit.theta) (JARs, source code, javadoc)
* DockerHub (docker images)
* GitHub pages ([wiki](todo), [javadoc](), [publications]())
* GitHub pages ([wiki](http://theta.mit.bme.hu/publications/wiki), [javadoc](http://theta.mit.bme.hu/javadoc), [publications](http://theta.mit.bme.hu/publications/))

These steps are only run after being manually invoked via [linux-build-test-deploy.yml](todo), and only over commits on the master branch.
These steps are only run after being manually invoked via [linux-build-test-deploy.yml](https://github.com/ftsrg/theta/actions/workflows/linux-build-test-deploy.yml), and only over commits on the master branch.

0 comments on commit 58b4d90

Please sign in to comment.