Skip to content

Commit

Permalink
Update GitHub workflows.
Browse files Browse the repository at this point in the history
I've adapted a few recommended workflows from https://github.com/block/example-jvm-maven:
(`scorecard.yaml`, `security.yaml`, `codeql.yaml`) and renamed `push_gem.yaml` to
`release.yaml`.
  • Loading branch information
myronmarston committed Dec 7, 2024
1 parent d9c0bb5 commit be93f03
Show file tree
Hide file tree
Showing 4 changed files with 143 additions and 2 deletions.
93 changes: 93 additions & 0 deletions .github/workflows/codeql.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
# 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: '42 22 * * 1'

jobs:
analyze:
name: Analyze
# 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
# Consider using larger runners 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

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

strategy:
fail-fast: false
matrix:
language: [ 'ruby' ]
# CodeQL supports [ 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift' ]
# Use only 'java-kotlin' to analyze code written in Java, Kotlin or both
# Use only 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support

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 }}
# 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


# Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
# If this step fails, then you should remove it and run the build manually (see below)

# Commenting out autobuild below; fails and needs custom build
#- name: Autobuild
# uses: github/codeql-action/autobuild@v3

# ℹ️ 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 the Autobuild fails above, remove it and uncomment the following three lines.
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.

# Custom build below
- name: Init Hermit
uses: cashapp/activate-hermit@v1
with:
cache: true
- name: Build, Test, and Verify
run: |
# Maven "test" lifecycle will build and test
mvn test
# End of custom build

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v3
with:
category: "/language:${{matrix.language}}"
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# This workflow was generated by https://github.com/rubygems/configure_trusted_publisher
name: Push Gem
name: Release

on:
workflow_dispatch:
Expand Down Expand Up @@ -84,7 +84,7 @@ jobs:
branch: release-v${{ inputs.version }}
title: "Release v${{ inputs.version }}"
body: |
- [ ] Confirm the [push-gem action](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}) succeeded before merging
- [ ] Confirm the [release action](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}) succeeded before merging
- [ ] Confirm this version bump should be merged into [${{ github.ref_name }}](https://github.com/${{ github.repository }}/tree/${{ github.ref_name }}) or change the base branch
- [ ] Review and edit the [GitHub Draft Release](https://github.com/${{ github.repository }}/releases) (can be done after this PR is merged)
Expand Down
26 changes: 26 additions & 0 deletions .github/workflows/scorecard.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Open Source Security Foundation Scorecard
on:
# For Branch-Protection check. Only the default branch is supported. See
# https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
branch_protection_rule:

# Manual trigger
workflow_dispatch:

# To guarantee Maintained check is occasionally updated. See
# https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
schedule:
- cron: "0 5 * * 1"
push:
branches: ["main"]

# Declare default permissions as read only.
permissions: read-all

jobs:
ossf:
uses: block/ospo/.github/workflows/scorecard.yml@main
secrets: inherit
permissions:
security-events: write
id-token: write
22 changes: 22 additions & 0 deletions .github/workflows/security.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Security and License Scans

on:
pull_request_target:
branches:
- main

push:
branches:
- main

# Run every day at 5am UTC
schedule:
- cron: "0 5 * * *"

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

jobs:
security-license-scan:
uses: block/ospo/.github/workflows/security.yml@main
secrets: inherit

0 comments on commit be93f03

Please sign in to comment.