Skip to content

Commit

Permalink
Merge with main and disable GitHub Actions (#7)
Browse files Browse the repository at this point in the history
* Added GitHub Actions for Maven build and updated README

* Change to project repository key in badges

* Added badges for monitoring repository and release activity

* [no ci] Added modules for project artifacts

* Added utility methods for LocalDate and LocalDateTime and corresponding test cases

* [no ci] Removed temporary module and merged code into main module

* Create tech stack docs (techstack.yml and techstack.md) (#2) (#3)

* Create techstack.yml

* Create techstack.md

---------

Co-authored-by: stack-file[bot] <147888899+stack-file[bot]@users.noreply.github.com>
Co-authored-by: stacksharebot <team@stackshare.io>

* Added documentation from StackShare

* Create tech stack docs (techstack.yml and techstack.md) (#2) (#4)

* Create techstack.yml

* Create techstack.md

---------

Co-authored-by: stack-file[bot] <147888899+stack-file[bot]@users.noreply.github.com>
Co-authored-by: stacksharebot <team@stackshare.io>

* [no ci] Regenerated the techstack files and added the code snippet in README

* GitHub Actions workflow commented out for Maven Publish and CodeQL

---------

Co-authored-by: stack-file[bot] <147888899+stack-file[bot]@users.noreply.github.com>
Co-authored-by: stacksharebot <team@stackshare.io>
  • Loading branch information
3 people authored Jun 17, 2024
1 parent 2860465 commit ee08c56
Show file tree
Hide file tree
Showing 6 changed files with 637 additions and 118 deletions.
164 changes: 82 additions & 82 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -1,91 +1,91 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
# ******** NOTE ********
# We have attempted to detect the languages in your repository. Please check
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
name: "CodeQL"
# # For most projects, this workflow file will not need changing; you simply need
# # to commit it to your repository.
# #
# # You may wish to alter this file to override the set of languages analyzed,
# # or to provide custom queries or build logic.
# #
# # ******** NOTE ********
# # We have attempted to detect the languages in your repository. Please check
# # the `language` matrix defined below to confirm you have the correct set of
# # supported CodeQL languages.
# #
# # name: "CodeQL"

on:
# push:
# branches: [ "main" ]
# pull_request:
# branches: [ "main" ]
schedule:
- cron: '26 2 * * 6'
# # on:
# # push:
# # branches: [ "main" ]
# # pull_request:
# # branches: [ "main" ]
# # schedule:
# # - cron: '26 2 * * 6'

jobs:
analyze:
name: Analyze (${{ matrix.language }})
# Runner size impacts CodeQL analysis time. To learn more, please see:
# - https://gh.io/recommended-hardware-resources-for-running-codeql
# - https://gh.io/supported-runners-and-hardware-resources
# - https://gh.io/using-larger-runners (github.com only)
# Consider using larger runners or machines with greater resources for possible analysis time improvements.
runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }}
permissions:
# required for all workflows
security-events: write
# # jobs:
# # analyze:
# # name: Analyze (${{ matrix.language }})
# # Runner size impacts CodeQL analysis time. To learn more, please see:
# # - https://gh.io/recommended-hardware-resources-for-running-codeql
# # - https://gh.io/supported-runners-and-hardware-resources
# # - https://gh.io/using-larger-runners (github.com only)
# # Consider using larger runners or machines with greater resources for possible analysis time improvements.
# runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
# timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }}
# permissions:
# # required for all workflows
# security-events: write

# required to fetch internal or private CodeQL packs
packages: read
# # required to fetch internal or private CodeQL packs
# packages: read

# only required for workflows in private repositories
actions: read
contents: read
# # only required for workflows in private repositories
# actions: read
# contents: read

strategy:
fail-fast: false
matrix:
include:
# CodeQL supports the following values keywords for 'language': 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift'
# Use `c-cpp` to analyze code written in C, C++ or both
# Use 'java-kotlin' to analyze code written in Java, Kotlin or both
# Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
# To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
# see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
# If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
# your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
steps:
- name: Checkout repository
uses: actions/checkout@v4
# strategy:
# fail-fast: false
# matrix:
# include:
# # CodeQL supports the following values keywords for 'language': 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift'
# # Use `c-cpp` to analyze code written in C, C++ or both
# # Use 'java-kotlin' to analyze code written in Java, Kotlin or both
# # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
# # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
# # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
# # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
# # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
# steps:
# - name: Checkout repository
# uses: actions/checkout@v4

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v3
with:
languages: ${{ matrix.language }}
build-mode: ${{ matrix.build-mode }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# # Initializes the CodeQL tools for scanning.
# - name: Initialize CodeQL
# uses: github/codeql-action/init@v3
# with:
# languages: ${{ matrix.language }}
# build-mode: ${{ matrix.build-mode }}
# # If you wish to specify custom queries, you can do so here or in a config file.
# # By default, queries listed here will override any specified in a config file.
# # Prefix the list here with "+" to use these queries and those in the config file.

# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
# queries: security-extended,security-and-quality
# # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
# # queries: security-extended,security-and-quality

# If the analyze step fails for one of the languages you are analyzing with
# "We were unable to automatically build your code", modify the matrix above
# to set the build mode to "manual" for that language. Then modify this step
# to build your code.
# ℹ️ Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
- if: matrix.build-mode == 'manual'
shell: bash
run: |
echo 'If you are using a "manual" build mode for one or more of the' \
'languages you are analyzing, replace this with the commands to build' \
'your code, for example:'
echo ' make bootstrap'
echo ' make release'
exit 1
# # If the analyze step fails for one of the languages you are analyzing with
# # "We were unable to automatically build your code", modify the matrix above
# # to set the build mode to "manual" for that language. Then modify this step
# # to build your code.
# # ℹ️ Command-line programs to run using the OS shell.
# # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
# - if: matrix.build-mode == 'manual'
# shell: bash
# run: |
# echo 'If you are using a "manual" build mode for one or more of the' \
# 'languages you are analyzing, replace this with the commands to build' \
# 'your code, for example:'
# echo ' make bootstrap'
# echo ' make release'
# exit 1

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v3
with:
category: "/language:${{matrix.language}}"
# - name: Perform CodeQL Analysis
# uses: github/codeql-action/analyze@v3
# with:
# category: "/language:${{matrix.language}}"
50 changes: 25 additions & 25 deletions .github/workflows/maven-publish.yml
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
# This workflow will build a package using Maven and then publish it to GitHub packages when a release is created
# For more information see: https://github.com/actions/setup-java/blob/main/docs/advanced-usage.md#apache-maven-with-a-settings-path

name: Maven Package
# name: Maven Package

on:
release:
types: [created]
# on:
# release:
# types: [created]

jobs:
build:
# jobs:
# build:

runs-on: ubuntu-latest
permissions:
contents: read
packages: write
# runs-on: ubuntu-latest
# permissions:
# contents: read
# packages: write

steps:
- uses: actions/checkout@v4
- name: Set up JDK 11
uses: actions/setup-java@v3
with:
java-version: '11'
distribution: 'temurin'
server-id: github # Value of the distributionManagement/repository/id field of the pom.xml
settings-path: ${{ github.workspace }} # location for the settings.xml file
# steps:
# - uses: actions/checkout@v4
# - name: Set up JDK 21
# uses: actions/setup-java@v3
# with:
# java-version: '21'
# distribution: 'temurin'
# server-id: github # Value of the distributionManagement/repository/id field of the pom.xml
# settings-path: ${{ github.workspace }} # location for the settings.xml file

- name: Build with Maven
run: mvn -B package --file pom.xml
# - name: Build with Maven
# run: mvn -B package --file pom.xml

- name: Publish to GitHub Packages Apache Maven
run: mvn deploy -s $GITHUB_WORKSPACE/settings.xml
env:
GITHUB_TOKEN: ${{ github.token }}
# - name: Publish to GitHub Packages Apache Maven
# run: mvn deploy -s $GITHUB_WORKSPACE/settings.xml
# env:
# GITHUB_TOKEN: ${{ github.token }}
4 changes: 2 additions & 2 deletions .github/workflows/maven.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ jobs:

steps:
- uses: actions/checkout@v4
- name: Set up JDK 20
- name: Set up JDK 21
uses: actions/setup-java@v3
with:
java-version: '20'
java-version: '21'
distribution: 'temurin'
cache: maven
- name: Build with Maven
Expand Down
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,17 @@ A Java common library
![GitHub closed issues](https://img.shields.io/github/issues-closed/shortthirdman-org/PrimeKit)
![GitHub Workflow Status (with event and branch)](https://img.shields.io/github/actions/workflow/status/shortthirdman-org/PrimeKit/release.yml?event=push&branch=main)

## Tech Stack

shortthirdman-org/PrimeKit is built on the following main stack:
## Tech Stack

> shortthirdman-org/PrimeKit is built on the following main stack:
- <img width='25' height='25' src='https://img.stackshare.io/service/995/K85ZWV2F.png' alt='Java'/> [Java](https://www.java.com) – Languages
- <img width='25' height='25' src='https://img.stackshare.io/service/2006/spring-framework-project-logo.png' alt='Spring Framework'/> [Spring Framework](https://spring.io/projects/spring-framework) – Frameworks (Full Stack)
- <img width='25' height='25' src='https://img.stackshare.io/service/1028/ASOhU5xJ.png' alt='PostgreSQL'/> [PostgreSQL](http://www.postgresql.org/) – Databases
- <img width='25' height='25' src='https://img.stackshare.io/service/7624/IG6D4Ro2_400x400.png' alt='Spring Data'/> [Spring Data](https://spring.io/projects/spring-data) – Database Tools
- <img width='25' height='25' src='https://img.stackshare.io/service/11563/actions.png' alt='GitHub Actions'/> [GitHub Actions](https://github.com/features/actions) – Continuous Integration
- <img width='25' height='25' src='https://img.stackshare.io/service/2020/874086.png' alt='JUnit'/> [JUnit](http://junit.org/) – Testing Frameworks

Full tech stack [here](/techstack.md)

Expand Down
Loading

0 comments on commit ee08c56

Please sign in to comment.