{"id":20136199,"url":"https://github.com/lucee/script-runner","last_synced_at":"2025-06-27T03:06:07.716Z","repository":{"id":44573697,"uuid":"384457899","full_name":"lucee/script-runner","owner":"lucee","description":"The Fastest way to run CI with Lucee","archived":false,"fork":false,"pushed_at":"2025-04-13T12:56:30.000Z","size":1231,"stargazers_count":8,"open_issues_count":2,"forks_count":4,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-06-08T20:01:51.633Z","etag":null,"topics":["cfml","ci","coldfusion","java","lucee","scriptrunner"],"latest_commit_sha":null,"homepage":"","language":"ColdFusion","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lucee.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-07-09T14:13:29.000Z","updated_at":"2025-04-13T12:56:33.000Z","dependencies_parsed_at":"2025-04-19T13:27:02.545Z","dependency_job_id":"c6ecce34-37df-476e-a9c3-845037ac020a","html_url":"https://github.com/lucee/script-runner","commit_stats":{"total_commits":62,"total_committers":2,"mean_commits":31.0,"dds":"0.016129032258064502","last_synced_commit":"de520ee658de8f7c6a45375fd448f948218edb61"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/lucee/script-runner","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucee%2Fscript-runner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucee%2Fscript-runner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucee%2Fscript-runner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucee%2Fscript-runner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lucee","download_url":"https://codeload.github.com/lucee/script-runner/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucee%2Fscript-runner/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260065957,"owners_count":22954100,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cfml","ci","coldfusion","java","lucee","scriptrunner"],"created_at":"2024-11-13T21:18:07.999Z","updated_at":"2025-06-27T03:06:07.706Z","avatar_url":"https://github.com/lucee.png","language":"ColdFusion","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Lucee Ant Script Runner\n\nQuickly run Lucee CFML applications headless (without a HTTP server) via the command line\n\n[![CI](https://github.com/lucee/script-runner/actions/workflows/main.yml/badge.svg)](https://github.com/lucee/script-runner/actions/workflows/main.yml)\n\nPlease report any issues, etc in the [Lucee Issue Tracker](https://luceeserver.atlassian.net/issues/?jql=labels%20%3D%20%22script-runner%22)\n\n## Command line Usage\n\nDefault `ant` will run the `sample/index.cfm` file\n\n![image](https://user-images.githubusercontent.com/426404/122402355-b0dbf980-cf7d-11eb-8837-37dec47d0713.png)\n\nYou can specify:\n\n- Lucee version `-DluceeVersion=` default `6.0.3.1`, (ie. 6.3.0.1, light-6.3.0.1, zero-6.3.0.1 )\n- Lucee version by query `-DluceeVersionQuery=\"5.4/stable/light` ( optional overrides luceeVersion, (version)/(stable/rc/snapshot)/(jar,light/zero) )\n- Webroot `-Dwebroot=`  (default `tests/`) on Windows, avoid a trailing \\ as that is treated as an escape character causes script runner to fail\n- CFML Script to run, `-Dexecute=` (default `/index.cfm`)\n- run script via include or _internalRequest (which runs the Application.cfc if present, default ) `-DexecuteScriptByInclude=\"true\"`\n- any extra extensions `-Dextensions=` (default ``)\n- manual extension install (`*.lex`) from a directory `-DextensionDir=` (default ``)\n- compile all cfml under webroot `-Dcompile=\"true\"`\n- pass in a full .CFConfig.json file `-DluceeCFConfig=\"/path/to/.CFConfig.json`\n- use a java debugger `-Ddebugger=\"true\"` opens a java debugging port 5000, with suspend=y\n- preCleanup `-DpreCleanup=\"true\"` purges the Lucee working dir before starting\n- postCleanup `-DpostCleanup=\"true\"` purges the Lucee working dir after finishing\n\n`ant -DluceeVersion=\"6.0.0.95-SNAPSHOT\" -Dwebroot=\"C:\\work\\lucee-docs\" -Dexecute=\"import.cfm\" -Dlucee.extensions=\"\"`\n\n`ant -DluceeVersion=\"6.0.0.95-SNAPSHOT\" -DextensionDir=\"C:\\work\\lucee-extensions\\extension-hibernate\\dist\"`\n\nIf no webroot is specfied, you can run the provided debug script, to see which extensions are available and all the env / sys properties\n\n`ant -buildfile=\"C:\\work\\script-runner\" -Dexecute=\"/debug.cfm\"`\n\n`ant -buildfile=\"C:\\work\\script-runner\" -Dexecute=\"/debug.cfm\" -DluceeVersion=\"light-6.0.0.95-SNAPSHOT\"` (`light` has no bundled extensions, `zero` has no extension or admin)\n\n## As a GitHub Action\n\nTo use as a GitHub Action, to run the PDF tests after building the PDF Extension, just add the following YAML\n\n```\n    - name: Checkout Lucee\n      uses: actions/checkout@v2\n      with:\n        repository: lucee/lucee\n        path: lucee\n    - name: Cache Maven packages\n      uses: actions/cache@v3\n      with:\n        path: ~/.m2\n        key: lucee-script-runner-maven-cache\n    - name: Cache Lucee files\n      uses: actions/cache@v3\n      with:\n        path: _actions/lucee/script-runner/main/lucee-download-cache\n        key: lucee-downloads\n    - name: Run Lucee Test Suite\n      uses: lucee/script-runner@main\n      with:\n        webroot: ${{ github.workspace }}/lucee/test\n        execute: /bootstrap-tests.cfm\n        luceeVersion: ${{ env.luceeVersion }}\n        luceeVersionQuery: 5.4/stable/light (optional, overrides luceeVersion )\n        extensions: (optional list of extension guids to install)\n        extensionDir: ${{ github.workspace }}/dist (for testing building an extension with CI)\n        antFlags: -d or -v etc (optional, good for debugging any ant issues)\n        compile: true (optional, compiles all the cfml under the webroot)\n        luceeCFConfig: /path/to/.CFConfig.json pass in additional configuration\n        debugger: true (optional) runs with java debugging enabled on port 5000\n        preCleanup: true (purges Lucee working directory before starting)\n        postCleanup: true (purges Lucee working directory after finishing)\n      env:\n        testLabels: pdf\n        testAdditional: ${{ github.workspace }}/tests\n```\n\nhttps://github.com/lucee/extension-pdf/blob/master/.github/workflows/main.yml\n\nThis will do the following steps\n\n- checkout a copy of the Lucee Code base\n- install any extension(s) (`*.lex`) found in `${{ github.workspace }}/dist`\n- run all tests with the label of \"pdf\"\n- run any additional tests found in the `/tests` directory of the current repository\n\n## As a BitBucket Pipeline\n\n```\nimage: atlassian/default-image:3\n\npipelines:\n  default:\n    - step:\n        name: Build and Test\n        caches:\n          - maven\n        script:\n          - ant -noinput -verbose -buildfile build.xml\n        artifacts:\n          - dist/**\n    - step:\n        name: Checkout Lucee Script-runner, Lucee and run tests\n        script:\n          - git clone https://github.com/lucee/script-runner\n          - git clone https://github.com/lucee/lucee\n          - export testLabels=\"PDF\"\n          - echo $testLabels\n          - ant -buildfile script-runner/build.xml -DluceeVersion=\"light-6.0.0.152-SNAPSHOT\" -Dwebroot=\"$BITBUCKET_CLONE_DIR/lucee/test\" -DextensionDir=\"$BITBUCKET_CLONE_DIR/dist\" -Dexecute=\"/bootstrap-tests.cfm\" -DtestAdditional=\"$BITBUCKET_CLONE_DIR/tests\"\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flucee%2Fscript-runner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flucee%2Fscript-runner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flucee%2Fscript-runner/lists"}