Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename master to main and update news #3128

Merged
merged 1 commit into from
Jan 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions .appveyor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ configuration:

branches:
only:
- master
- main

# changes to these files don't need to trigger testing
skip_commits:
Expand All @@ -31,9 +31,9 @@ skip_commits:
- Android.mk
- _config.yml

# Travis advances the master-tot tag to current top of the tree after
# each push into the master branch, because it relies on that tag to
# upload build artifacts to the master-tot release. This will cause
# Travis advances the main-tot tag to current top of the tree after
# each push into the main branch, because it relies on that tag to
# upload build artifacts to the main-tot release. This will cause
# double testing for each push on Appveyor: one for the push, one for
# the tag advance. Disable testing tags.
skip_tags: true
Expand Down Expand Up @@ -73,7 +73,7 @@ after_test:
}
- cd install
# Zip all glslang artifacts for uploading and deploying
- 7z a glslang-master-windows-"%PLATFORM%"-"%CONFIGURATION%".zip
- 7z a glslang-main-windows-"%PLATFORM%"-"%CONFIGURATION%".zip
bin\glslangValidator.exe
bin\spirv-remap.exe
include\glslang\*
Expand All @@ -97,12 +97,12 @@ deploy:
- provider: GitHub
auth_token:
secure: YglcSYdl0TylEa59H4K6lylBEDr586NAt2EMgZquSo+iuPrwgZQuJLPCoihSm9y6
release: master-tot
description: "Continuous build of the latest master branch by Appveyor and Github"
release: main-tot
description: "Continuous build of the latest main branch by Appveyor and Github"
artifact: artifacts-zip
draft: false
prerelease: false
force_update: true
on:
branch: master
branch: main
APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2015
10 changes: 5 additions & 5 deletions .github/workflows/continuous_deployment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ on:
workflow_dispatch:
push:
branches:
- master
- main

jobs:
linux:
Expand Down Expand Up @@ -71,7 +71,7 @@ jobs:
- name: Zip
if: ${{ matrix.compiler.cc == 'clang' }}
env:
ARCHIVE: glslang-master-${{matrix.os.family}}-${{matrix.cmake_build_type}}.zip
ARCHIVE: glslang-main-${{matrix.os.family}}-${{matrix.cmake_build_type}}.zip
run: |
cd build/install
zip ${ARCHIVE} \
Expand All @@ -92,7 +92,7 @@ jobs:
- name: Deploy
if: ${{ matrix.compiler.cc == 'clang' }}
env:
ARCHIVE: glslang-master-${{matrix.os.family}}-${{matrix.cmake_build_type}}.zip
ARCHIVE: glslang-main-${{matrix.os.family}}-${{matrix.cmake_build_type}}.zip
uses: actions/github-script@v5
with:
script: |
Expand Down Expand Up @@ -142,7 +142,7 @@ jobs:
cd ../Test && ./runtests
- name: Zip
env:
ARCHIVE: glslang-master-${{matrix.os.family}}-${{matrix.cmake_build_type}}.zip
ARCHIVE: glslang-main-${{matrix.os.family}}-${{matrix.cmake_build_type}}.zip
run: |
cd build/install
zip ${ARCHIVE} \
Expand All @@ -162,7 +162,7 @@ jobs:
lib/libSPIRV-Tools-opt.a
- name: Deploy
env:
ARCHIVE: glslang-master-${{matrix.os.family}}-${{matrix.cmake_build_type}}.zip
ARCHIVE: glslang-main-${{matrix.os.family}}-${{matrix.cmake_build_type}}.zip
uses: actions/github-script@v5
with:
script: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/continuous_integration.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ on:
workflow_dispatch:
pull_request:
branches:
- master
- main

jobs:
linux:
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/deploy.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,22 @@ module.exports = async ({github, context, core}) => {
await github.rest.git.updateRef({
owner: context.repo.owner,
repo: context.repo.repo,
ref: 'tags/master-tot',
ref: 'tags/main-tot',
sha: context.sha
})
} catch (error) {
core.setFailed(`upload master-tot tag; ${error.name}; ${error.message}`)
core.setFailed(`upload main-tot tag; ${error.name}; ${error.message}`)
}

let release
try {
release = await github.rest.repos.getReleaseByTag({
owner: context.repo.owner,
repo: context.repo.repo,
tag: 'master-tot'
tag: 'main-tot'
})
} catch (error) {
core.setFailed(`get the master release; ${error.name}; ${error.message}`)
core.setFailed(`get the main release; ${error.name}; ${error.message}`)
}

try {
Expand All @@ -28,7 +28,7 @@ module.exports = async ({github, context, core}) => {
release_id: release.data.id
})
} catch (error) {
core.setFailed(`update the master release; ${error.name}; ${error.message}`)
core.setFailed(`update the main release; ${error.name}; ${error.message}`)
}

let release_assets
Expand Down
34 changes: 12 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,17 @@
# News

1. Default branch will be renamed from 'master' to 'main' [as requested by Khronos](https://github.com/KhronosGroup/glslang/issues/3107) on 01/30/2023.
1. [As discussed in #3107](https://github.com/KhronosGroup/glslang/issues/3107), the default branch of this repository is now 'main'. This change should be transparent to repository users, since github rewrites many references to the old 'master' branch to 'main'. However, if you have a checked-out local clone, you may wish to take the following steps as recommended by github:

2. Visual Studio 2013 is no longer supported

[As scheduled](https://github.com/KhronosGroup/glslang/blob/9eef54b2513ca6b40b47b07d24f453848b65c0df/README.md#planned-deprecationsremovals),
Microsoft Visual Studio 2013 is no longer officially supported. \
Please upgrade to at least Visual Studio 2015.

3. The versioning scheme is being improved, and you might notice some differences. This is currently WIP, but will be coming soon. See, for example, PR #2277.

4. If you get a new **compilation error due to a missing header**, it might be caused by this planned removal:

**SPIRV Folder, 1-May, 2020.** Glslang, when installed through CMake,
will install a `SPIRV` folder into `${CMAKE_INSTALL_INCLUDEDIR}`.
This `SPIRV` folder is being moved to `glslang/SPIRV`.
During the transition the `SPIRV` folder will be installed into both locations.
The old install of `SPIRV/` will be removed as a CMake install target no sooner than May 1, 2020.
See issue #1964.
```sh
git branch -m master main
git fetch origin
git branch -u origin/main main
git remote set-head origin -a
```

If people are only using this location to get spirv.hpp, I recommend they get that from [SPIRV-Headers](https://github.com/KhronosGroup/SPIRV-Headers) instead.
2. Visual Studio 2019 is now the minimum supported compiler for windows. This change was driven by the external dependency on SPIRV-Tools.

[![appveyor status](https://ci.appveyor.com/api/projects/status/q6fi9cb0qnhkla68/branch/master?svg=true)](https://ci.appveyor.com/project/Khronoswebmaster/glslang/branch/master)
[![appveyor status](https://ci.appveyor.com/api/projects/status/q6fi9cb0qnhkla68/branch/main?svg=true)](https://ci.appveyor.com/project/Khronoswebmaster/glslang/branch/main)
![Continuous Deployment](https://github.com/KhronosGroup/glslang/actions/workflows/continuous_deployment.yml/badge.svg)

# Glslang Components and Status
Expand Down Expand Up @@ -101,9 +91,9 @@ There is also a non-shader extension:
## Building (CMake)

Instead of building manually, you can also download the binaries for your
platform directly from the [master-tot release][master-tot-release] on GitHub.
platform directly from the [main-tot release][main-tot-release] on GitHub.
Those binaries are automatically uploaded by the buildbots after successful
testing and they always reflect the current top of the tree of the master
testing and they always reflect the current top of the tree of the main
branch.

### Dependencies
Expand Down Expand Up @@ -557,4 +547,4 @@ std::vector<uint32_t> compileShaderToSPIRV_Vulkan(glslang_stage_t stage, const c
[bison]: https://www.gnu.org/software/bison/
[googletest]: https://github.com/google/googletest
[bison-gnu-win32]: http://gnuwin32.sourceforge.net/packages/bison.htm
[master-tot-release]: https://github.com/KhronosGroup/glslang/releases/tag/master-tot
[main-tot-release]: https://github.com/KhronosGroup/glslang/releases/tag/main-tot