Граф коммитов

53 Коммитов

Автор SHA1 Сообщение Дата
Koen Vlaswinkel 9a77748a59 Fix auto-fixable markdownlint violations
This fixes all violations that can be fixed by using
`npm run lint:markdown -- --fix`.

This also updates the markdownlint configuration to require dashes in
unstyled lists. This results in the least amount of changes to Markdown
files. The default setting results in rewriting the complete CHANGELOG
file.
2023-12-14 10:47:39 +01:00
Sam Partington c86dcafd2e Fix generic links 2023-04-04 15:59:57 +01:00
Charis Kyriakou 50e89ba1a3 Remove primer packages 2023-03-17 13:46:43 +00:00
Charis Kyriakou c3d28e395c Move testing docs to separate file 2023-03-07 11:37:00 +00:00
Charis Kyriakou 840cfbf3f6 Move releasing docs to separate doc file 2023-03-07 11:33:46 +00:00
Koen Vlaswinkel 46670cc7d6 Clarify CLI integration test CI runs 2023-02-13 11:39:38 +01:00
Koen Vlaswinkel b412896d54 Make purpose of `no-workspace` tests clearer 2023-02-13 11:39:07 +01:00
Koen Vlaswinkel 3917b14a58 Merge remote-tracking branch 'origin/main' into koesie10/improve-test-setup 2023-02-13 09:21:39 +01:00
Koen Vlaswinkel 642b8e5960 Add documentation for new test suite and scripts 2023-02-08 13:28:18 +00:00
Koen Vlaswinkel ef1fe756cb Add recommendation for version number bumps 2023-02-08 11:21:33 +00:00
Charis Kyriakou 09c60ecfc8
Improve docs around different test suites (#1959) 2023-01-12 15:15:24 +00:00
Charis Kyriakou 35d1d8ba6e
Move VS Code integration tests to /test directory (#1912) 2023-01-03 10:31:38 +00:00
Elena Tanasoiu 1e84bc9116
Move test plan into VSCode markdown file
This moves our existing test plan under a "Required testing" section.

We're also adding the scenarios used for testing live results under an "Optional testing" section.
2022-12-21 16:55:33 +00:00
Koen Vlaswinkel 24a61d387d Add documentation for running a single test 2022-11-25 13:36:07 +01:00
Andrew Eisenberg 767a5cf809 Merge branch 'main' into aeisenberg/assert-version 2022-11-07 15:21:57 -08:00
Elena Tanasoiu 20e7432ca0
Mention `npm run build` in the docs 2022-11-03 12:22:24 +00:00
Elena Tanasoiu 8e7fa4f1d6
Update docs to add reminder about using test data 2022-11-03 09:49:52 +00:00
Elena Tanasoiu d8a3e49d19
Update contribution docs 2022-11-02 14:09:53 +00:00
Andrew Eisenberg 9f03db2f28 Fix typos 2022-10-28 09:54:33 -07:00
Charis Kyriakou b15626853b
Add script to help with scenario recording (#1671) 2022-10-28 09:22:11 +00:00
Charis Kyriakou dbb549d5fb
Add mock GitHub API server docs (#1661) 2022-10-27 12:08:08 +00:00
Elena Tanasoiu e5dcffc04b
Clarify the roles of different types of tests
And also clean up the explanation on how to run each type of test.
2022-10-19 18:38:27 +01:00
Robert cc00456cbc
Clarify step of the release process 2022-09-21 16:56:28 +01:00
Koen Vlaswinkel 6fdc632743 Add overview page for Storybook 2022-09-07 17:06:23 +02:00
Koen Vlaswinkel 6018ebaca9 Setup Storybook for testing UI components
This sets up Storybook for testing of React components. It adds stories
for some of the MRVA components. It does not add stories for the main
MRVA views since those are not independent of VSCode and need to be run
from within VSCode.
2022-09-06 10:55:55 +02:00
Elena Tanasoiu e0b2aa9b45
Update docs for running cli-integration tests 2022-06-23 09:13:20 +01:00
Elena Tanasoiu 0b15a166fa
Follow guidance for git tagging in contribution docs
Adding two things:
- A bit more detail on how to add a tag and how to delete a badly named one
- Switch to the official way of sharing tags according to the git docs[^1]

[^1]: https://git-scm.com/book/en/v2/Git-Basics-Tagging
2022-06-15 16:57:38 +01:00
Elena Tanasoiu 8964ec1a4d
Use the same Node version as VSCode
As recommended here https://github.com/github/vscode-codeql/pull/1369#issuecomment-1142418037, we want to stay in sync with the current node version shipped with
VSCode (v16.13.0):

32d40cf44e/remote/.yarnrc (L2)

For this we can add a `.nvmrc` file to alert nvm to switch to the preferred version automatically.

It will also help prevent builds from failing when setting up the project for the first time, as building the extension currently fails in Node v18: https://github.com/github/vscode-codeql/issues/1373

We're also updating the docs to mention using `nvm` to manage node versions and point to the right place to check for current supported versions.
2022-06-13 11:21:25 +01:00
Shati Patel eb2520e7ca Fix outdated description of "watch" command 2022-04-28 15:29:38 +01:00
Andrew Eisenberg 76e983d19c v1.6.3
Also adds a step in our release process to manually test the new
extension build.
2022-04-04 12:30:41 -07:00
Andrew Eisenberg 227fe3ee6b
Fix typo
Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>
2022-03-31 12:12:57 -07:00
Andrew Eisenberg a0954a1dc0 Move vscode marketplace pat isntructions to internal docs 2022-03-31 10:22:33 -07:00
Angela P Wen 33b1465ccc Docs: add clarification on directory for running tests via CLI 2021-12-10 12:29:15 -08:00
Andrew Eisenberg 0ef635bc68
Use the correct environment variable in integration tests (#994)
Also, fix documentation and launch configs to specify the correct and
complete set of environment variables we should be using.
2021-11-03 23:04:14 +00:00
Andrew Eisenberg ff02d1da05 Add extra emphasis in contributing docs 2021-05-06 14:54:48 -07:00
Marcono1234 a86c1ce69b Use HTTPS for links 2021-03-14 22:58:50 -07:00
Andrew Eisenberg 6304fe0e30
Update typings for mocha (#752)
* Update typings for mocha

This is includes an update of the lock file to the v2 format. It's a big
change, but not much is happening here. I thought it best to keep it
separate.

* Fix globalSetup/teardown for mocha

Updating the typings for mocha uncovered an error in how we were
registering global setups and teardowns.

When calling `mocha.globalSetup` or `mocha.globalTeardown`, any
previously registered globals are overwritten. The workaround
is to attach globals directly to the internal options object.

This is a requirement because we are now registering globals in
multiple files.

Unfortunately, the typings for mocha do not permit this and I may need
to fix them again.
2021-02-11 16:48:52 -08:00
Andrew Eisenberg 02080cd797 Change text and fix link of modal dialog
Modal dialogs do not allow for markdown text. The link was invalid.
Also, make CodeQL more prominent in the dialog.
2021-01-29 17:46:42 -08:00
Andrew Eisenberg cace4acb1e Update internal docs for publishing
And remove unused file.
2021-01-11 13:38:21 -08:00
Andrew Eisenberg 696c16b5b4 Add workflow jobs to deploy extension
This adds two new jobs to the `Release` workflow. These
jobs are blocked behind an environment. When approved
by a committer, the extension will be deployed to
Open VSX and VS Code marketplace.

Also, update contributing docs for open-vsx publishing.
2021-01-11 13:38:21 -08:00
Andrew Eisenberg e719c68321 Update the contributing docs
Just adds some more details.
2020-11-04 12:47:38 -08:00
Andrew Eisenberg 2dcf3b3feb Fix whitespace in CONTRIBUTING.md
Co-authored-by: jcreedcmu <jcreed@gmail.com>
2020-10-13 11:35:40 -07:00
Andrew Eisenberg 50efdea9d6 Remove build before launch in launch.json
And update contributing with new instructions.
2020-10-13 11:35:40 -07:00
jcreedcmu 4519e0f951
Update CONTRIBUTING.md
Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>
2020-07-23 09:14:37 -04:00
Jason Reed 2b712827df Clean up build instructions 2020-07-22 13:05:13 -04:00
Jason Reed 762edd137c Fix CONTRIBUTING.md to reflect changes to build process. 2020-07-21 13:09:44 -04:00
Jason Reed 963ff9f458 Change references to master branch to main branch
I have already pushed `main` upstream pointing at the same commit as
master, so this PR should be safe to merge. To the best of my
knowledge all that's necessary after that is to change the
default branch
in https://github.com/github/vscode-codeql/settings/branches.
2020-06-16 14:00:02 -04:00
jcreedcmu 9d2504959b
Update CONTRIBUTING.md 2020-03-17 16:52:18 -04:00
jcreedcmu a096e79bd4
Expand release documentation 2020-03-17 16:45:24 -04:00
Andrew Eisenberg 1efa9f1082 Update contributing documentation and launch config
Adds section in CONTRIBUTING.md to document how to run tests. Also,
fixes some markdown linting warnings.

And fixes the launch config for running unit tests.
2020-03-07 16:36:09 -08:00