Compare commits

..

2 Commits

Author SHA1 Message Date
Alexei Lozovsky ac2ceb2811 show me the env 2021-03-07 13:51:48 +09:00
Alexei Lozovsky cdfca13739 test only this branch 2021-03-07 13:51:40 +09:00
9 changed files with 591 additions and 1952 deletions
+15 -56
View File
@@ -6,6 +6,7 @@ on:
branches: branches:
- master - master
- release/* - release/*
- wip/path-test
schedule: schedule:
- cron: '0 6 * * *' - cron: '0 6 * * *'
@@ -18,67 +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: What's in the env?
run: npm run lint
- name: Enable Developer Command Prompt (amd64)
uses: ./
with:
arch: amd64
- name: Compile and run some C code (amd64)
shell: cmd shell: cmd
run: | run: set
cl.exe hello.c
hello.exe
- name: Enable Developer Command Prompt (amd64_x86)
uses: ./
with:
arch: amd64_x86
- name: Compile and run some C code (x86)
shell: cmd
run: |
cl.exe hello.c
hello.exe
- name: Enable Developer Command Prompt (amd64_arm)
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:
name: npm audit
runs-on: ubuntu-latest
steps:
- name: Check out source code
uses: actions/checkout@v2
- run: npm install
- run: npm audit --audit-level=moderate --production
- run: npm audit --audit-level=critical
alias-arch:
name: arch aliases
runs-on: windows-latest
steps:
- name: Check out source code
uses: actions/checkout@v2
- name: Download Internet
run: npm install
- name: Enable Developer Command Prompt - name: Enable Developer Command Prompt
uses: ./ uses: ./
with: - name: What's in the env now?
arch: Win32 shell: cmd
run: set
- name: Compile and run some C code - name: Compile and run some C code
shell: cmd shell: cmd
run: | run: |
cl.exe hello.c cl.exe hello.c
hello.exe hello.exe
audit:
name: npm audit
if: false
runs-on: windows-latest
steps:
- name: Check out source code
uses: actions/checkout@v2
- run: npm install
- run: npm audit --audit-level=moderate
+2 -3
View File
@@ -23,9 +23,8 @@ jobs:
hello.exe hello.exe
audit: audit:
name: npm audit name: npm audit
runs-on: ubuntu-latest runs-on: windows-latest
steps: steps:
- name: Check out source code - name: Check out source code
uses: actions/checkout@v2 uses: actions/checkout@v2
- run: npm audit --audit-level=moderate --production - run: npm audit --audit-level=moderate
- run: npm audit --audit-level=critical
+1
View File
@@ -0,0 +1 @@
node_modules
+12 -101
View File
@@ -8,57 +8,12 @@ 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: `x86`, `x64` (default), `amd64` (synonym for x64)
- `x64` (default) or its synonyms: `amd64`, `win64`, `x86_64`, `x86-64` - cross-compilation: `x86_amd64`, `x86_arm`, `x86_arm64`,
- `x86` or its synonyms: `win32` `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 +26,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).
+35 -106
View File
@@ -5,14 +5,25 @@ const path = require('path')
const process = require('process') const process = require('process')
const PROGRAM_FILES_X86 = process.env['ProgramFiles(x86)'] const PROGRAM_FILES_X86 = process.env['ProgramFiles(x86)']
const PROGRAM_FILES = [process.env['ProgramFiles(x86)'], process.env['ProgramFiles']]
const EDITIONS = ['Enterprise', 'Professional', 'Community'] const EDITIONS = ['Enterprise', 'Professional', 'Community']
const VERSIONS = ['2022', '2019', '2017'] 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()
@@ -34,15 +45,13 @@ function findVcvarsall() {
// If that does not work, try the standard installation locations, // If that does not work, try the standard installation locations,
// starting with the latest and moving to the oldest. // starting with the latest and moving to the oldest.
for (const prog_files of PROGRAM_FILES) { for (const ver of VERSIONS) {
for (const ver of VERSIONS) { for (const ed of EDITIONS) {
for (const ed of EDITIONS) { path = `${PROGRAM_FILES_X86}\\Microsoft Visual Studio\\${ver}\\${ed}\\VC\\Auxiliary\\Build\\vcvarsall.bat`
path = `${prog_files}\\Microsoft Visual Studio\\${ver}\\${ed}\\VC\\Auxiliary\\Build\\vcvarsall.bat` core.info(`Trying standard location: ${path}`)
core.info(`Trying standard location: ${path}`) if (fs.existsSync(path)) {
if (fs.existsSync(path)) { core.info(`Found standard location: ${path}`)
core.info(`Found standard location: ${path}`) return path
return path
}
} }
} }
} }
@@ -59,23 +68,7 @@ function findVcvarsall() {
throw new Error('Microsoft Visual Studio not found') throw new Error('Microsoft Visual Studio not found')
} }
function isPathVariable(name) { function main() {
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(';')
}
/** See https://github.com/ilammy/msvc-dev-cmd#inputs */
function setupMSVCDevCmd(arch, sdk, toolset, uwp, spectre) {
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!')
return return
@@ -84,18 +77,11 @@ function setupMSVCDevCmd(arch, sdk, toolset, uwp, spectre) {
// Add standard location of "vswhere" to PATH, in case it's not there. // Add standard location of "vswhere" to PATH, in case it's not there.
process.env.PATH += path.delimiter + VSWHERE_PATH process.env.PATH += path.delimiter + VSWHERE_PATH
// There are all sorts of way the architectures are called. In addition to const arch = core.getInput('arch')
// values supported by Microsoft Visual C++, recognize some common aliases. const sdk = core.getInput('sdk')
let arch_aliases = { const toolset = core.getInput('toolset')
"win32": "x86", const uwp = core.getInput('uwp')
"win64": "x64", const spectre = core.getInput('spectre')
"x86_64": "x64",
"x86-64": "x64",
}
// Ignore case when matching as that's what humans expect.
if (arch.toLowerCase() in arch_aliases) {
arch = arch_aliases[arch.toLowerCase()]
}
// Due to the way Microsoft Visual C++ is configured, we have to resort to the following hack: // Due to the way Microsoft Visual C++ is configured, we have to resort to the following hack:
// Call the configuration batch file and then output *all* the environment variables. // Call the configuration batch file and then output *all* the environment variables.
@@ -114,79 +100,22 @@ function setupMSVCDevCmd(arch, sdk, toolset, uwp, spectre) {
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() for (let string of environment) {
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
// an error and *still* exit successfully. Parse out errors from output
// which don't look like environment variables, and fail if appropriate.
const error_messages = vcvars_output.filter((line) => {
if (line.match(/^\[ERROR.*\]/)) {
// Don't print this particular line which will be confusing in output.
if (!line.match(/Error in script usage. The correct usage is:$/)) {
return true
}
}
return false
})
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.
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`)
} }
exports.setupMSVCDevCmd = setupMSVCDevCmd
function main() {
var arch = core.getInput('arch')
const sdk = core.getInput('sdk')
const toolset = core.getInput('toolset')
const uwp = core.getInput('uwp')
const spectre = core.getInput('spectre')
setupMSVCDevCmd(arch, sdk, toolset, uwp, spectre)
}
try { try {
main() main()
-13
View File
@@ -1,13 +0,0 @@
{
"name": "msvc-dev-cmd",
"version": "1.10.0",
"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=="
}
}
}
+46 -17
View File
@@ -1,16 +1,40 @@
{ {
"name": "@actions/core", "_args": [
"version": "1.2.6", [
"description": "Actions core lib", "@actions/core@1.2.6",
"keywords": [ "/Users/ilammy/Documents/dev/ilammy/msvc-dev-cmd"
"github", ]
"actions",
"core"
], ],
"homepage": "https://github.com/actions/toolkit/tree/main/packages/core", "_from": "@actions/core@1.2.6",
"license": "MIT", "_id": "@actions/core@1.2.6",
"main": "lib/core.js", "_inBundle": false,
"types": "lib/core.d.ts", "_integrity": "sha512-ZQYitnqiyBc3D+k7LsgSBmMDVkOVidaagDG7j3fOym77jNunWRuYx7VSHa9GNfFZh+zh61xsCjRj4JxMZlDqTA==",
"_location": "/@actions/core",
"_phantomChildren": {},
"_requested": {
"type": "version",
"registry": true,
"raw": "@actions/core@1.2.6",
"name": "@actions/core",
"escapedName": "@actions%2fcore",
"scope": "@actions",
"rawSpec": "1.2.6",
"saveSpec": null,
"fetchSpec": "1.2.6"
},
"_requiredBy": [
"/"
],
"_resolved": "https://registry.npmjs.org/@actions/core/-/core-1.2.6.tgz",
"_spec": "1.2.6",
"_where": "/Users/ilammy/Documents/dev/ilammy/msvc-dev-cmd",
"bugs": {
"url": "https://github.com/actions/toolkit/issues"
},
"description": "Actions core lib",
"devDependencies": {
"@types/node": "^12.0.2"
},
"directories": { "directories": {
"lib": "lib", "lib": "lib",
"test": "__tests__" "test": "__tests__"
@@ -19,6 +43,15 @@
"lib", "lib",
"!.DS_Store" "!.DS_Store"
], ],
"homepage": "https://github.com/actions/toolkit/tree/main/packages/core",
"keywords": [
"github",
"actions",
"core"
],
"license": "MIT",
"main": "lib/core.js",
"name": "@actions/core",
"publishConfig": { "publishConfig": {
"access": "public" "access": "public"
}, },
@@ -32,10 +65,6 @@
"test": "echo \"Error: run tests from root\" && exit 1", "test": "echo \"Error: run tests from root\" && exit 1",
"tsc": "tsc" "tsc": "tsc"
}, },
"bugs": { "types": "lib/core.d.ts",
"url": "https://github.com/actions/toolkit/issues" "version": "1.2.6"
},
"devDependencies": {
"@types/node": "^12.0.2"
}
} }
+476 -1653
View File
File diff suppressed because it is too large Load Diff
+4 -3
View File
@@ -1,10 +1,11 @@
{ {
"name": "msvc-dev-cmd", "name": "msvc-dev-cmd",
"version": "1.10.0", "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",
@@ -30,6 +31,6 @@
"@actions/core": "^1.2" "@actions/core": "^1.2"
}, },
"devDependencies": { "devDependencies": {
"eslint": "^7" "eslint": "^6.8.0"
} }
} }