Skip to content

Commit

Permalink
update matrix in README to correspond to tests
Browse files Browse the repository at this point in the history
  • Loading branch information
carsonRadtke committed Oct 14, 2024
1 parent d520eb6 commit 785f7a1
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 19 deletions.
9 changes: 5 additions & 4 deletions .github/workflows/compilers.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ on:
pull_request:
branches: [ main ]

# TODO (@carsonradtke)
# - [ ] Update README with latest versions actively tested
# These jobs are correlated with the officially supported compilers
# and toolsets. If you change any versions, please update README.md.

jobs:
gcc:
strategy:
Expand Down Expand Up @@ -71,7 +72,7 @@ jobs:
strategy:
matrix:
cxx_version: [ 14, 17, 20 ]
generator: [ 'Visual Studio 17 2022' ]
generator: [ 'Visual Studio 16 2019', 'Visual Studio 17 2022' ]
build_type: [ 'Debug', 'Release' ]
extra_args: [ '', '-T ClangCL' ]
runs-on: windows-latest
Expand All @@ -87,7 +88,7 @@ jobs:
gsl_cxx_standard: ${{ matrix.cxx_version }}
extra_cmake_args: ${{ matrix.extra_args }}

- uses: microsoft/setup-msbuild@v1
- uses: microsoft/setup-msbuild@v2

- name: build
working-directory: build
Expand Down
23 changes: 8 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,24 +86,17 @@ This is based on [CppCoreGuidelines semi-specification](https://github.com/isocp

# Quick Start
## Supported Compilers / Toolsets
The GSL officially supports the latest and previous major versions of VS with MSVC & LLVM, GCC, Clang, and XCode with Apple-Clang.
Within these two major versions, we try to target the latest minor updates / revisions (although this may be affected by
delays between a toolchain's release and when it becomes widely available for use).
Below is a table showing the versions currently being tested.
The GSL officially support recent major versions of Visual Studio with both MSVC and LLVM, GCC, Clang, and XCode with Apple-Clang.
For each of these major versions, the GSL officially supports C++14, C++17, and C++20.
Below is a table showing the versions currently being tested (also see [.github/workflows/compilers.yml](the workflow).)

Compiler |Toolset Versions Currently Tested
:------- |--:
XCode | 13.2.1 & 12.5.1
GCC | 11[^1] & 10[^2]
Clang | 12[^2] & 11[^2]
Visual Studio with MSVC | VS2022[^3] & VS2019[^4]
Visual Studio with LLVM | VS2022[^3] & VS2019[^4]


[^1]: Precise version may be found in the [latest CI results](https://dev.azure.com/cppstat/GSL/_build?definitionId=1&branchFilter=26).
[^2]: Precise version may be found in the [latest CI results](https://dev.azure.com/cppstat/GSL/_build?definitionId=1&branchFilter=26). Should be the version specified [here](https://github.com/actions/virtual-environments/blob/main/images/linux/Ubuntu2004-Readme.md#language-and-runtime).
[^3]: Precise version may be found in the [latest CI results](https://dev.azure.com/cppstat/GSL/_build?definitionId=1&branchFilter=26). Should be the version specified [here](https://github.com/actions/virtual-environments/blob/main/images/win/Windows2022-Readme.md#visual-studio-enterprise-2022).
[^4]: Precise version may be found in the [latest CI results](https://dev.azure.com/cppstat/GSL/_build?definitionId=1&branchFilter=26). Should be the version specified [here](https://github.com/actions/virtual-environments/blob/main/images/win/Windows2019-Readme.md#visual-studio-enterprise-2019).
GCC | 10, 11, 12
XCode | 14.3.1, 15.4
Clang | 13, 14, 15
Visual Studio with MSVC | VS2019, VS2022
Visual Studio with LLVM | VS2019, VS2022

---
If you successfully port GSL to another platform, we would love to hear from you!
Expand Down

0 comments on commit 785f7a1

Please sign in to comment.