diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml new file mode 100644 index 0000000..6d90c99 --- /dev/null +++ b/.github/workflows/codeql.yml @@ -0,0 +1,43 @@ +name: CodeQL +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + schedule: + - cron: '0 0 * * 1' + +jobs: + analyze: + name: Analyze (${{ matrix.language }}) + permissions: + security-events: write + actions: read + contents: read + strategy: + fail-fast: false + matrix: + include: + - language: actions + build-mode: none + - language: swift + build-mode: autobuild + runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }} + steps: + - name: Select an Xcode which provides Swift 6.2.4 + if: ${{ matrix.language == 'swift' }} + uses: maxim-lobanov/setup-xcode@ed7a3b1fda3918c0306d1b724322adc0b8cc0a90 # v1.7.0 + with: + xcode-version: '26.3' + - name: Checkout repository + uses: actions/checkout@v6 + - name: Initialize CodeQL + uses: github/codeql-action/init@v4 + with: + languages: ${{ matrix.language }} + queries: security-extended + build-mode: ${{ matrix.build-mode }} + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v4 + with: + category: "/language:${{matrix.language}}" diff --git a/README.md b/README.md index 2daa5cd..4bbcfdd 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,15 @@ -

+

ConsoleKit
-
-Documentation -Team Chat -MIT License -Continuous Integration -Code Coverage -Swift 6.1+ -

+ +[![Documentation](https://design.vapor.codes/images/readthedocs.svg)](https://docs.vapor.codes/4.0/) +[![Team Chat](https://design.vapor.codes/images/discordchat.svg)](https://discord.gg/vapor) +[![MIT License](https://design.vapor.codes/images/mitlicense.svg)](LICENSE) +[![Continuous Integration](https://img.shields.io/github/actions/workflow/status/vapor/console-kit/test.yml?event=push&style=plastic&logo=github&label=tests&logoColor=ccc)](https://github.com/vapor/console-kit/actions/workflows/test.yml) +[![Code Coverage](https://img.shields.io/codecov/c/gh/vapor/console-kit?style=plastic&logo=codecov&label=codecov)](https://codecov.io/gh/vapor/console-kit) +[![Swift 6.2+](https://design.vapor.codes/images/swift62up.svg)](https://swift.org) + +

@@ -19,15 +20,15 @@ `ConsoleKit` provides utilities for interacting with a console in a Swift application. It provides: * Utilities for sending text (including styles and colors, when supported) to and reading input from a terminal. -* ``ConsoleLogger``, a [SwiftLog](https://github.com/apple/swift-log) `LogHandler` implementation for customizable logging to a console. +* `ConsoleLogger`, a [SwiftLog](https://github.com/apple/swift-log) `LogHandler` implementation for customizable logging to a console. ### Supported Platforms -ConsoleKit supports all platforms supported by Swift 6.1 and later. +ConsoleKit supports all platforms supported by Swift 6.2 and later. ### Installation -Use the SPM string to easily include the dependendency in your `Package.swift` file +Use the Github repository URL to add the dependency to your `Package.swift` manifest: ```swift .package(url: "https://github.com/vapor/console-kit.git", from: "5.0.0")