Skip to content

Commit

Permalink
Updates for main branch rename.
Browse files Browse the repository at this point in the history
  • Loading branch information
HansKristian-Work committed Jan 12, 2023
1 parent 88c6b49 commit 49e4117
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ name: CI

on:
push:
branches: [ master ]
branches: [ main ]
pull_request:
types: [ opened, synchronize, reopened ]

Expand Down
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
SPIRV-Cross is a tool designed for parsing and converting SPIR-V to other shader languages.

[![CI](https://github.com/KhronosGroup/SPIRV-Cross/actions/workflows/main.yml/badge.svg)](https://github.com/KhronosGroup/SPIRV-Cross/actions/workflows/main.yml)
[![Build Status](https://ci.appveyor.com/api/projects/status/github/KhronosGroup/SPIRV-Cross?svg=true&branch=master)](https://ci.appveyor.com/project/HansKristian-Work/SPIRV-Cross)
[![Build Status](https://ci.appveyor.com/api/projects/status/github/KhronosGroup/SPIRV-Cross?svg=true&branch=main)](https://ci.appveyor.com/project/HansKristian-Work/SPIRV-Cross)

## Features

Expand All @@ -31,6 +31,10 @@ However, most missing features are expected to be "trivial" improvements at this

SPIRV-Cross has been tested on Linux, iOS/OSX, Windows and Android. CMake is the main build system.

### NOTE: main branch rename

On 2023-01-12, `master` was renamed to `main` as per Khronos policy.

### Linux and macOS

Building with CMake is recommended, as it is the only build system which is tested in continuous integration.
Expand Down Expand Up @@ -499,7 +503,7 @@ to update the reference files and include these changes as part of the pull requ
Always make sure you are running the correct version of glslangValidator as well as SPIRV-Tools when updating reference files.
See `checkout_glslang_spirv_tools.sh` which revisions are currently expected. The revisions change regularly.

In short, the master branch should always be able to run `./test_shaders.py shaders` and friends without failure.
In short, the main branch should always be able to run `./test_shaders.py shaders` and friends without failure.
SPIRV-Cross uses Travis CI to test all pull requests, so it is not strictly needed to perform testing yourself if you have problems running it locally.
A pull request which does not pass testing on Travis will not be accepted however.

Expand Down
2 changes: 1 addition & 1 deletion checkout_glslang_spirv_tools.sh
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ fi

if [ -d external/spirv-headers ]; then
cd external/spirv-headers
git pull origin master
git fetch origin
git checkout $SPIRV_HEADERS_REV
cd ../..
else
Expand Down

0 comments on commit 49e4117

Please sign in to comment.