Compare commits

..

4 Commits

Author SHA1 Message Date
Alexei Lozovsky 5c9e3ff532 wat 2021-03-09 23:22:30 +09:00
Alexei Lozovsky 78b8d0d58b extra path 2021-03-09 23:18:16 +09:00
Alexei Lozovsky 34741d07c4 look at env 2021-03-09 22:43:32 +09:00
Alexei Lozovsky dd06567c9a prep 2021-03-09 22:42:36 +09:00
7 changed files with 63 additions and 1468 deletions
+13 -32
View File
@@ -6,6 +6,7 @@ on:
branches: branches:
- master - master
- release/* - release/*
- wip/bash
schedule: schedule:
- cron: '0 6 * * *' - cron: '0 6 * * *'
@@ -18,46 +19,25 @@ jobs:
uses: actions/checkout@v2 uses: actions/checkout@v2
- name: Download Internet - name: Download Internet
run: npm install run: npm install
- name: Run eslint - name: Enable Developer Command Prompt
run: npm run lint
- name: Enable Developer Command Prompt (amd64)
uses: ./ uses: ./
with: - name: Compile and run some C code
arch: amd64
- name: Compile and run some C code (amd64)
shell: cmd shell: cmd
run: | run: |
cl.exe hello.c cl.exe hello.c
hello.exe hello.exe
- name: Enable Developer Command Prompt (amd64_x86) - name: Extra path
uses: ./ shell: bash
with: run: echo "C:\\foo" >> $GITHUB_PATH
arch: amd64_x86 - name: Check out bash env
- name: Compile and run some C code (x86) shell: bash
shell: cmd
run: | run: |
cl.exe hello.c env
hello.exe which link || :
- name: Enable Developer Command Prompt (amd64_arm) which cl || :
uses: ./
with:
arch: amd64_arm
- name: Compile some C code (arm)
shell: cmd
run: |
cl.exe hello.c
dumpbin /headers hello.exe
- name: Enable Developer Command Prompt (amd64_arm64)
uses: ./
with:
arch: amd64_arm64
- name: Compile some C code (arm64)
shell: cmd
run: |
cl.exe hello.c
dumpbin /headers hello.exe
audit: audit:
name: npm audit name: npm audit
if: false
runs-on: windows-latest runs-on: windows-latest
steps: steps:
- name: Check out source code - name: Check out source code
@@ -66,6 +46,7 @@ jobs:
- run: npm audit --audit-level=moderate - run: npm audit --audit-level=moderate
alias-arch: alias-arch:
name: arch aliases name: arch aliases
if: false
runs-on: windows-latest runs-on: windows-latest
steps: steps:
- name: Check out source code - name: Check out source code
+1
View File
@@ -0,0 +1 @@
node_modules
+10 -97
View File
@@ -8,57 +8,14 @@ This sets up the environment for compiling C/C++ code from command line.
Supports Windows. Does nothing on Linux and macOS. Supports Windows. Does nothing on Linux and macOS.
## Example usage
Basic usage for default compilation settings is like this:
```yaml
jobs:
test:
steps:
- uses: actions/checkout@v2
- uses: ilammy/msvc-dev-cmd@v1
- name: Build something requiring CL.EXE
run: |
cmake -G "NMake Makefiles" .
nmake
# ...
```
If you want something non-default,
like using a specific version of Visual Studio,
or cross-compling for a differen target,
you will need to configure those settings via inputs:
```yaml
jobs:
test:
# Run a job for each of the specified target architectures:
strategy:
matrix:
arch:
- amd64
- amd64_x86
- amd64_arm64
steps:
- uses: actions/checkout@v2
- uses: ilammy/msvc-dev-cmd@v1
with:
arch: ${{ matrix.arch }}
- name: Build something requiring CL.EXE
run: |
cmake -G "NMake Makefiles" .
nmake
# ...
```
## Inputs ## Inputs
- `arch` target architecture - `arch` target architecture
- native compilation: - native compilation:
- `x64` (default) or its synonyms: `amd64`, `win64` - `x64` (default) or its synonyms: `amd64`, `win64`
- `x86` or its synonyms: `win32` - `x86` or its synonyms: `win32`
- cross-compilation: `x86_amd64`, `x86_arm`, `x86_arm64`, `amd64_x86`, `amd64_arm`, `amd64_arm64` - cross-compilation: `x86_amd64`, `x86_arm`, `x86_arm64`,
`amd64_x86`, `amd64_arm`, `amd64_arm64`
- `sdk` Windows SDK to use - `sdk` Windows SDK to use
- do not specify to use the default SDK - do not specify to use the default SDK
- or specify full Windows 10 SDK number (e.g, `10.0.10240.0`) - or specify full Windows 10 SDK number (e.g, `10.0.10240.0`)
@@ -71,64 +28,20 @@ jobs:
- `uwp` set `true` to build for Universal Windows Platform (i.e., for Windows Store) - `uwp` set `true` to build for Universal Windows Platform (i.e., for Windows Store)
- `spectre` set `true` to use Visual Studio libraries with [Spectre](https://meltdownattack.com) mitigations - `spectre` set `true` to use Visual Studio libraries with [Spectre](https://meltdownattack.com) mitigations
## Caveats ## Example usage
### Name conflicts with `shell: bash`
Using `shell: bash` in Actions may shadow some of the paths added by MSVC.
In particular, `link.exe` (Microsoft C linker) is prone to be shadowed by `/usr/bin/link` (GNU filesystem link tool).
Unfortunately, this happens because GitHub Actions unconditionally *prepend* GNU paths when `shell: bash` is used,
on top of any paths set by `msvc-dev-cmd`, every time at the start of each new step.
Hence, there aren't many non-destructive options here.
If you experience compilation errors where `link` complains about unreasonable command-line arguments,
“extra operand *something-something* that's probably it.
Recommended workaround is to remove `/usr/bin/link` if that interferes with your builds.
If this is not acceptable, please file an issue, then we'll figure out something better.
### Reconfiguration
You can invoke `ilammy/msvc-dev-cmd` multiple times during your jobs with different inputs
to reconfigure the environment for building with different settings
(e.g., to target multiple architectures).
```yaml ```yaml
jobs: jobs:
release: test:
steps: - uses: actions/checkout@v1
# ... - uses: ilammy/msvc-dev-cmd@v1
- name: Configure build for amd64 - name: Build something requiring CL.EXE
uses: ilammy/msvc-dev-cmd@v1 run: |
with: cmake -G "NMake Makefiles" .
arch: amd64 nmake
- run: build # (for amd64)
- name: Configure build for x86
uses: ilammy/msvc-dev-cmd@v1
with:
arch: amd64_x86
- run: build # (for x86)
- name: Configure build for ARM64
uses: ilammy/msvc-dev-cmd@v1
with:
arch: amd64_arm64
- run: build # (for ARM64)
# ... # ...
``` ```
This mostly works but it's not really recommended
since Developer Command Prompt was not meant for recursive reconfiguration.
That said, if it does not work for you, please file an issue.
Consider using [`strategy.matrix`](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix)
to execute different build configuration in parallel, independent environments.
## License ## License
MIT, see [LICENSE](LICENSE). MIT, see [LICENSE](LICENSE).
+31 -61
View File
@@ -11,6 +11,19 @@ const VERSIONS = ['2019', '2017']
const VSWHERE_PATH = `${PROGRAM_FILES_X86}\\Microsoft Visual Studio\\Installer` const VSWHERE_PATH = `${PROGRAM_FILES_X86}\\Microsoft Visual Studio\\Installer`
const InterestingVariables = [
'INCLUDE',
'LIB',
'LIBPATH',
'VCINSTALLDIR',
'Path',
'Platform',
'VisualStudioVersion',
/^VCTools/,
/^VSCMD_/,
/^WindowsSDK/i,
]
function findWithVswhere(pattern) { function findWithVswhere(pattern) {
try { try {
let installationPath = child_process.execSync(`vswhere -products * -latest -prerelease -property installationPath`).toString().trim() let installationPath = child_process.execSync(`vswhere -products * -latest -prerelease -property installationPath`).toString().trim()
@@ -55,21 +68,6 @@ function findVcvarsall() {
throw new Error('Microsoft Visual Studio not found') throw new Error('Microsoft Visual Studio not found')
} }
function isPathVariable(name) {
const pathLikeVariables = ['PATH', 'INCLUDE', 'LIB', 'LIBPATH']
return pathLikeVariables.indexOf(name.toUpperCase()) != -1
}
function filterPathValue(path) {
let paths = path.split(';')
// Remove duplicates by keeping the first occurance and preserving order.
// This keeps path shadowing working as intended.
function unique(value, index, self) {
return self.indexOf(value) === index
}
return paths.filter(unique).join(';')
}
function main() { function main() {
if (process.platform != 'win32') { if (process.platform != 'win32') {
core.info('This is not a Windows virtual environment, bye!') core.info('This is not a Windows virtual environment, bye!')
@@ -113,65 +111,37 @@ function main() {
args.push('-vcvars_spectre_libs=spectre') args.push('-vcvars_spectre_libs=spectre')
} }
const vcvars = `"${findVcvarsall()}" ${args.join(' ')}` const command = `"${findVcvarsall()}" ${args.join(' ')} && set`
core.debug(`vcvars command-line: ${vcvars}`) core.debug(`Running: ${command}`)
const environment = child_process.execSync(command, {shell: "cmd"}).toString().split('\r\n')
const cmd_output_string = child_process.execSync(`set && cls && ${vcvars} && cls && set`, {shell: "cmd"}).toString()
const cmd_output_parts = cmd_output_string.split('\f')
const old_environment = cmd_output_parts[0].split('\r\n')
const vcvars_output = cmd_output_parts[1].split('\r\n')
const new_environment = cmd_output_parts[2].split('\r\n')
// If vsvars.bat is given an incorrect command line, it will print out // If vsvars.bat is given an incorrect command line, it will print out
// an error and *still* exit successfully. Parse out errors from output // an error and *still* exit successfully. Parse out errors from output
// which don't look like environment variables, and fail if appropriate. // which don't look like environment variables, and fail if appropriate.
const error_messages = vcvars_output.filter((line) => { var failed = false
for (let line of environment) {
if (line.match(/^\[ERROR.*\]/)) { if (line.match(/^\[ERROR.*\]/)) {
failed = true
// Don't print this particular line which will be confusing in output. // Don't print this particular line which will be confusing in output.
if (!line.match(/Error in script usage. The correct usage is:$/)) { if (line.match(/Error in script usage. The correct usage is:$/)) {
return true continue
}
core.error(line)
} }
} }
return false if (failed) {
}) throw new Error('invalid parameters')
if (error_messages.length > 0) {
throw new Error('invalid parameters' + '\r\n' + error_messages.join('\r\n'))
} }
// Convert old environment lines into a dictionary for easier lookup. for (let string of environment) {
let old_env_vars = {}
for (let string of old_environment) {
const [name, value] = string.split('=') const [name, value] = string.split('=')
old_env_vars[name] = value for (let pattern of InterestingVariables) {
} if (name.match(pattern)) {
core.exportVariable(name, value)
// Now look at the new environment and export everything that changed. break
// These are the variables set by vsvars.bat. Also export everything }
// that was not there during the first sweep: those are new variables.
core.startGroup('Environment variables')
for (let string of new_environment) {
// vsvars.bat likes to print some fluff at the beginning.
// Skip lines that don't look like environment variables.
if (!string.includes('=')) {
continue;
}
let [name, new_value] = string.split('=')
let old_value = old_env_vars[name]
// For new variables "old_value === undefined".
if (new_value !== old_value) {
core.info(`Setting ${name}`)
// Special case for a bunch of PATH-like variables: vcvarsall.bat
// just prepends its stuff without checking if its already there.
// This makes repeated invocations of this action fail after some
// point, when the environment variable overflows. Avoid that.
if (isPathVariable(name)) {
new_value = filterPathValue(new_value)
}
core.exportVariable(name, new_value)
} }
} }
core.endGroup()
core.info(`Configured Developer Command Prompt`) core.info(`Configured Developer Command Prompt`)
} }
-13
View File
@@ -1,13 +0,0 @@
{
"name": "msvc-dev-cmd",
"version": "1.8.1",
"lockfileVersion": 2,
"requires": true,
"packages": {
"node_modules/@actions/core": {
"version": "1.2.6",
"resolved": "https://registry.npmjs.org/@actions/core/-/core-1.2.6.tgz",
"integrity": "sha512-ZQYitnqiyBc3D+k7LsgSBmMDVkOVidaagDG7j3fOym77jNunWRuYx7VSHa9GNfFZh+zh61xsCjRj4JxMZlDqTA=="
}
}
}
+5 -1263
View File
File diff suppressed because it is too large Load Diff
+3 -2
View File
@@ -1,10 +1,11 @@
{ {
"name": "msvc-dev-cmd", "name": "msvc-dev-cmd",
"version": "1.8.1", "version": "1.1.1",
"description": "GitHub Action to setup Developer Command Prompt for Microsoft Visual C++", "description": "GitHub Action to setup Developer Command Prompt for Microsoft Visual C++",
"main": "index.js", "main": "index.js",
"scripts": { "scripts": {
"lint": "eslint index.js" "lint": "eslint index.js",
"test": "eslint index.js"
}, },
"repository": { "repository": {
"type": "git", "type": "git",