Andrew Eisenberg
873c91c4f7
Update README with detailed information
...
Update `README.md` to include detailed information about inputs, workflow permissions, build modes, and actions.
* **Inputs**: Add a section on inputs, including the `config` option, `languages`, `queries`, `packs`, `db-location`, `ram`, `threads`, and `source-root`.
* **Workflow Permissions**: Add a section on workflow permissions required for the actions.
* **Build Modes**: Add a section explaining the different build modes available for the actions (`none`, `autobuild`, `manual`).
* **Actions**: Add a section describing the different actions (`init`, `autobuild`, `analyze`, `upload-sarif`, `resolve-environment`, `start-proxy`) and how to use them, with links to the relevant documentation on GitHub.
---
For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/github/codeql-action?shareId=XXXX-XXXX-XXXX-XXXX ).
2024-10-03 13:42:25 -07:00
Henry Mercer
77f9025999
Fix formatting issue with GHES compatibility table
...
Also add a note about GHES 3.11 supporting but not shipping with CodeQL Action v3.
2024-09-05 12:19:23 +01:00
Andrew Eisenberg
693677d432
Update README.md
2024-08-30 10:55:17 -07:00
Andrew Eisenberg
c28337900b
Change "recommended" to "minimum"
...
The wording was causing confusion.
2024-08-29 13:20:13 -07:00
Henry Mercer
def1e359d7
Improve consistency in supported version naming
2024-08-08 10:55:33 +01:00
Henry Mercer
6ef274e152
Add details of supported versions for GHES 3.14
...
The release candidate is [now out](https://github.blog/changelog/2024-08-07-the-github-enterprise-server-3-14-release-candidate-is-available/ ).
2024-08-08 10:52:29 +01:00
Henry Mercer
84f2bfe7be
Remove GHES 3.9 from supported versions
2024-08-05 17:43:55 +01:00
Henry Mercer
f1335fc8bd
Add details of supported versions for GHES 3.13
2024-06-12 16:41:07 +01:00
Andrew Eisenberg
43beef629f
Update README.md
...
Co-authored-by: Henry Mercer <henrymercer@github.com>
2024-05-08 11:44:51 -07:00
Andrew Eisenberg
e50fb8fff0
Add a compatibility table to the README
...
Specifies the versions of the action, CLI and GHES that are jointly compatible.
2024-05-07 13:58:01 -07:00
Henry Mercer
db9620802e
README: Fix a couple of typos
2024-02-28 16:23:37 +00:00
Andrew Eisenberg
36c51ac2b5
Capitalize Code Scanning
...
Co-authored-by: Henry Mercer <henrymercer@github.com>
2024-02-20 10:46:27 -08:00
Andrew Eisenberg
c709994d27
Add permissions info to README
2024-02-16 15:09:31 -08:00
Henry Mercer
9a9b0e4a8f
Add a README section about supported versions
2024-01-26 14:09:22 +00:00
Angela P Wen
b8e349d982
Remove Node 16 deprecation note ( #2076 )
2024-01-09 21:19:07 -08:00
Angela P Wen
4a368f64ad
Add announcement on Node 16 deprecation ( #1960 )
2023-10-18 23:00:03 +00:00
Sam Browning
66572f0900
Update README.md
2023-08-21 11:37:17 -04:00
Henry Mercer
d9d3212c79
Simplify README to recommend default setup and refer to docs
2023-07-28 17:30:34 +01:00
Mathias Vorreiter Pedersen
59c6251800
Fix README link
2023-07-06 17:14:12 +01:00
Henry Mercer
4a409ace8f
Link to CONTRIBUTING doc from README
2023-05-25 17:03:48 +01:00
Andrew Eisenberg
b1b3d00b62
Add link to changenote for custom config
...
Also, use a better link in the readme.
2023-05-01 11:06:31 -07:00
tgrall
f398a65921
fix after review from @henrymercer
2023-04-18 05:43:21 +02:00
tgrall
fc374f5e9a
remove the documentation about workflow parameters
2023-04-10 07:59:26 +02:00
tgrall
b4e6f81a72
resolve comments from @henrymercer
2023-04-10 07:56:09 +02:00
Tugdual Grall
c9f360d9af
Update README.md : during PR Review
...
Co-authored-by: Henry Mercer <henry.mercer@me.com>
2023-04-10 07:38:31 +02:00
Tugdual Grall
d2950c11f0
Update README.md : during PR Review
...
Co-authored-by: Henry Mercer <henry.mercer@me.com>
2023-04-10 07:37:52 +02:00
Tugdual Grall
696504dcab
Accept change in PR
...
Co-authored-by: Henry Mercer <henry.mercer@me.com>
2023-04-10 07:35:57 +02:00
tgrall
fe4a785361
rename new parameter from configuration to config
2023-04-01 07:13:01 +02:00
Tugdual Grall
f1fb80a041
Update README.md
2023-03-18 16:17:44 +01:00
Tugdual Grall
f81f52702f
Update README.md - typo
2023-03-18 16:17:16 +01:00
Tugdual Grall
ee44252240
- Add new configuration Parameter
...
- Write test to check it is read from configuration
- Update documentation
2023-03-18 13:40:54 +00:00
Mahmoud Mabrok Fouad
c5c475188a
docs: add direct link to website
...
To make it easy for users to go to website for more info.
2023-02-05 13:56:35 +02:00
Henry Mercer
55a437c003
Add Ruby to README
2022-11-16 18:31:04 +00:00
Angela P Wen
ac0112f7f1
Add Go to list of supported languages
2022-11-01 08:28:56 -07:00
Marco Gario
2faa3e16f3
Remove outdated guidance on missing analysis
...
As of December 2021, we do not return missing base analysis anymore.
2022-05-17 12:04:13 +02:00
Aditya Sharad
bf4ba6945d
README: Replace git.io shortlink with full link
...
git.io is deprecated, so use the full link to docs.github.com instead.
2022-04-26 02:14:44 -07:00
Henry Mercer
a2949f47b3
Update actions/checkout from v2 to v3
2022-03-30 19:46:09 +01:00
Henry Mercer
7871f0d5e1
Update CodeQL Action from v1 to v2 in README
2022-03-30 19:46:09 +01:00
Henry Mercer
6de8537e54
Update README now build tracing is compatible with Windows 2022
2022-03-21 15:31:51 +00:00
Daniel Beck
47dd636fbc
Fix link to docs
2022-03-02 15:30:11 +01:00
Henry Mercer
a6d606becc
Update changelog and README with build tracing compatibility info
2022-02-09 12:47:13 +00:00
Aditya Sharad
a57642e1a0
README: Minor formatting edits
2021-09-01 15:56:15 -07:00
iotboy
bf91ac91d4
fix indentation error on README.md
2021-08-17 15:52:11 +08:00
Andrew Eisenberg
21753283b1
Updates the permissions block to be minimal
...
And adds a permissions block to the README.
2021-08-09 13:30:16 -07:00
Robin Neatherway
2a20b15eca
Update README.md
...
Co-authored-by: Aditya Sharad <6874315+adityasharad@users.noreply.github.com>
2021-07-16 10:08:37 +01:00
Robin Neatherway
0d0f0ef80e
Suggest limiting push/pull_request triggers
...
Bring the template in line with the one used by the UI.
2021-07-15 17:20:13 +01:00
Andrew Eisenberg
7c391e9640
Update readme to include section on missing analysis
...
Fixes #598
2021-06-25 10:44:47 -07:00
Andrew Eisenberg
d9a17baf2f
Merge branch 'main' into patch-1
2021-05-28 15:29:27 -07:00
Andrew Eisenberg
7ae8d165a6
Add the first changelog entry
...
(Adding the changelog itself.)
2021-05-20 09:24:30 -07:00
okyanusoz
8a1d7c290f
Fix wording in README
2021-04-03 21:55:03 +03:00