codeql-action/CONTRIBUTING.md

# Contributing

[fork]: https://github.com/github/codeql-action/fork
[pr]: https://github.com/github/codeql-action/compare
[code-of-conduct]: CODE_OF_CONDUCT.md

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE).

Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.

## Development and Testing

Before you start, ensure that you have a recent version of node installed. You can see which version of node is used by the action in `init/action.yml`.

### Common tasks

* Transpile the TypeScript to JavaScript: `npm run build`.  Note that the JavaScript files are committed to git.
* Run tests: `npm run test`.  You’ll need to ensure that the JavaScript files are up-to-date first by running the command above.
* Run the linter: `npm run lint`.

This project also includes configuration to run tests from VSCode (with support for breakpoints) - open the test file you wish to run and choose "Debug AVA test file" from the Run menu in the Run panel.

You may want to run `tsc --watch` from the command line or inside of vscode in order to ensure build artifacts are up to date as you are working.

### Checking in compiled artifacts and `node_modules`

Because CodeQL Action users consume the code directly from this repository, and there can be no build step during an GitHub Actions run, this repository contains all compiled artifacts and node modules. There is a PR check that will fail if any of the compiled artifacts are not up to date. Compiled artifacts are stored in the `lib/` directory. For all day-to-day development purposes, this folder can be ignored.

Only run `npm install` if you are explicitly changing the set of dependencies in `package.json`. The `node_modules` directory should be up to date when you check out, but if for some reason, there is an inconsistency use `npm ci && npm run removeNPMAbsolutePaths` to ensure the directory is in a state consistent with the `package-lock.json`. There is a PR check to ensure the consistency of the `node_modules` directory.

### Running the action

To see the effect of your changes and to test them, push your changes in a branch and then look at the [Actions output](https://github.com/github/codeql-action/actions) for that branch.  You can also exercise the code locally by running the automated tests.

### Running the action locally

It is possible to run this action locally via [act](https://github.com/nektos/act) via the following steps:

1. Create a GitHub [Personal Access Token](https://github.com/settings/tokens) (PAT).
1. Install [act](https://github.com/nektos/act) v0.2.10 or greater.
1. Add a `.env` file in the root of the project you are running:

  ```bash
  CODEQL_LOCAL_RUN=true
  GITHUB_SERVER_URL=https://github.com

  # Optional, for better logging
  GITHUB_JOB=<ANY_JOB_NAME>
  ```

1. Run `act -j codeql -s GITHUB_TOKEN=<PAT>`

Running locally will generate the CodeQL database and run all the queries, but it will avoid uploading and reporting results to GitHub. Note that this must be done on a repository that _consumes_ this action, not this repository. The use case is to debug failures of this action on specific repositories.

### Integration tests

As well as the unit tests (see _Common tasks_ above), there are integration tests, defined in `.github/workflows/integration-testing.yml`.  These are run by a CI check.  Depending on the change you’re making, you may want to add a test to this file or extend an existing one.

### Building the CodeQL runner

Navigate to the `runner` directory and run `npm install` to install dependencies needed only for compiling the CodeQL runner. Run `npm run build-runner` to output files to the `runner/dist` directory.

## Submitting a pull request

1. [Fork][fork] and clone the repository
2. Create a new branch: `git checkout -b my-branch-name`
3. Make your change, add tests, and make sure the tests still pass
4. Push to your fork and [submit a pull request][pr]
5. Pat yourself on the back and wait for your pull request to be reviewed and merged.

If you're a GitHub staff member, you can merge your own PR once it's approved; for external contributors, GitHub staff will merge your PR once it's approved.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

- Write tests.
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).

## Resources

- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
- [GitHub Help](https://help.github.com)
-												Use templated strings for better readability

											
										
										
											2020-07-22 20:07:27 +03:00
+								# Contributing
-												Initial commit (from f5274cbdce4ae7c9e4b937dcdf95ac70ae436d5f)

											
										
										
											2020-04-28 17:46:47 +03:00
 								[fork]: https://github.com/github/codeql-action/fork
 								[pr]: https://github.com/github/codeql-action/compare
 								[code-of-conduct]: CODE_OF_CONDUCT.md
 								Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
 								Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE).
 								Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
-												Add development instructions to CONTRIBUTING.md

											
										
										
											2020-07-01 16:32:04 +03:00
+								## Development and Testing
-												Point people at init/action.yml for node version

https://github.com/github/codeql-action/pull/94#discussion_r448502825

											
										
										
											2020-07-02 12:55:00 +03:00
+								Before you start, ensure that you have a recent version of node installed. You can see which version of node is used by the action in `init/action.yml`.
-												Add development instructions to CONTRIBUTING.md

											
										
										
											2020-07-01 16:32:04 +03:00
 								### Common tasks
 								* Transpile the TypeScript to JavaScript: `npm run build`.  Note that the JavaScript files are committed to git.
 								* Run tests: `npm run test`.  You’ll need to ensure that the JavaScript files are up-to-date first by running the command above.
 								* Run the linter: `npm run lint`.
-												Add support for debugging from VSCode

https://github.com/avajs/ava/blob/master/docs/recipes/debugging-with-vscode.md recommends passing the `debug` option to Ava.  However, in my experience Ava waits indefinitely when this option is used, without actually running any tests.

The increased timeout setting is so that tests won't fail prematurely because you're slowly stepping through code.

											
										
										
											2020-07-14 11:49:21 +03:00
+								This project also includes configuration to run tests from VSCode (with support for breakpoints) - open the test file you wish to run and choose "Debug AVA test file" from the Run menu in the Run panel.
-												Update contributing guide

This adds a section on checking in compiled artifacts.

											
										
										
											2021-05-10 18:44:55 +03:00
+								You may want to run `tsc --watch` from the command line or inside of vscode in order to ensure build artifacts are up to date as you are working.
 								### Checking in compiled artifacts and `node_modules`
-												Fix information about `npm ci`

											
										
										
											2021-05-10 20:05:30 +03:00
+								Because CodeQL Action users consume the code directly from this repository, and there can be no build step during an GitHub Actions run, this repository contains all compiled artifacts and node modules. There is a PR check that will fail if any of the compiled artifacts are not up to date. Compiled artifacts are stored in the `lib/` directory. For all day-to-day development purposes, this folder can be ignored.
-												Update contributing guide

This adds a section on checking in compiled artifacts.

											
										
										
											2021-05-10 18:44:55 +03:00
-												Remove confusing words

Co-authored-by: Robert <robertbrignull@github.com>
											
										
										
											2021-05-10 20:25:31 +03:00
+								Only run `npm install` if you are explicitly changing the set of dependencies in `package.json`. The `node_modules` directory should be up to date when you check out, but if for some reason, there is an inconsistency use `npm ci && npm run removeNPMAbsolutePaths` to ensure the directory is in a state consistent with the `package-lock.json`. There is a PR check to ensure the consistency of the `node_modules` directory.
-												Update contributing guide

This adds a section on checking in compiled artifacts.

											
										
										
											2021-05-10 18:44:55 +03:00
-												Add development instructions to CONTRIBUTING.md

											
										
										
											2020-07-01 16:32:04 +03:00
+								### Running the action
 								To see the effect of your changes and to test them, push your changes in a branch and then look at the [Actions output](https://github.com/github/codeql-action/actions) for that branch.  You can also exercise the code locally by running the automated tests.
-												Allow the codeql-action to be run locally (#117)

* Allow the codeql-action to be run locally

This change allows the codeql-action to be run locally through
[act](https://github.com/nektos/act).

In order to run the action locally, you need to do two things:

1. Add the `CODEQL_LOCAL_RUN: true` environment variable. The only way
   I could figure out how to do this was to add it directly in the
   workflow file in an `env` block. It _should_ be possible to add it
   through a `.env` file and pass it to `act`, but I couldn't get it
   working.
2. Run this command `act -j codeql -s GITHUB_TOKEN=<MY_PAT>`

Setting the `CODEQL_LOCAL_RUN` env var will fill in missing env vars
that the action needs, but isn't set by `act`. It will also avoid
making api calls to github that would fail locally.

This is a refactoring discussed in
https://github.com/github/dsp-codeql/issues/36

											
										
										
											2020-08-05 00:35:20 +03:00
+								### Running the action locally
 								It is possible to run this action locally via [act](https://github.com/nektos/act) via the following steps:
 . Create a GitHub [Personal Access Token](https://github.com/settings/tokens) (PAT).
 . Install [act](https://github.com/nektos/act) v0.2.10 or greater.
 . Add a `.env` file in the root of the project you are running:
 								  ```bash
 								  CODEQL_LOCAL_RUN=true
-												Fix invalid API call when running locally

The method getAnalysisKey would call getWorkflowPath and raise an API Error.

This change follows the pattern in prepareLocalRunEnvironment to set a dummy value for the required environment variable, therefore shortcutting the API request.

											
										
										
											2020-11-04 12:37:42 +03:00
+								  GITHUB_SERVER_URL=https://github.com
-												Allow the codeql-action to be run locally (#117)

* Allow the codeql-action to be run locally

This change allows the codeql-action to be run locally through
[act](https://github.com/nektos/act).

In order to run the action locally, you need to do two things:

1. Add the `CODEQL_LOCAL_RUN: true` environment variable. The only way
   I could figure out how to do this was to add it directly in the
   workflow file in an `env` block. It _should_ be possible to add it
   through a `.env` file and pass it to `act`, but I couldn't get it
   working.
2. Run this command `act -j codeql -s GITHUB_TOKEN=<MY_PAT>`

Setting the `CODEQL_LOCAL_RUN` env var will fill in missing env vars
that the action needs, but isn't set by `act`. It will also avoid
making api calls to github that would fail locally.

This is a refactoring discussed in
https://github.com/github/dsp-codeql/issues/36

											
										
										
											2020-08-05 00:35:20 +03:00
 								  # Optional, for better logging
 								  GITHUB_JOB=<ANY_JOB_NAME>
 								  ```
 . Run `act -j codeql -s GITHUB_TOKEN=<PAT>`
 								Running locally will generate the CodeQL database and run all the queries, but it will avoid uploading and reporting results to GitHub. Note that this must be done on a repository that _consumes_ this action, not this repository. The use case is to debug failures of this action on specific repositories.
-												Add development instructions to CONTRIBUTING.md

											
										
										
											2020-07-01 16:32:04 +03:00
+								### Integration tests
 								As well as the unit tests (see _Common tasks_ above), there are integration tests, defined in `.github/workflows/integration-testing.yml`.  These are run by a CI check.  Depending on the change you’re making, you may want to add a test to this file or extend an existing one.
-												rename CLI to runner

											
										
										
											2020-08-24 16:21:03 +03:00
+								### Building the CodeQL runner
-												add minimal instructions for building CLI

											
										
										
											2020-08-24 16:04:29 +03:00
-												rename CLI to runner

											
										
										
											2020-08-24 16:21:03 +03:00
+								Navigate to the `runner` directory and run `npm install` to install dependencies needed only for compiling the CodeQL runner. Run `npm run build-runner` to output files to the `runner/dist` directory.
-												add minimal instructions for building CLI

											
										
										
											2020-08-24 16:04:29 +03:00
-												Initial commit (from f5274cbdce4ae7c9e4b937dcdf95ac70ae436d5f)

											
										
										
											2020-04-28 17:46:47 +03:00
+								## Submitting a pull request
 . [Fork][fork] and clone the repository
 . Create a new branch: `git checkout -b my-branch-name`
 . Make your change, add tests, and make sure the tests still pass
 . Push to your fork and [submit a pull request][pr]
-												Add details of who will merge (CONTRIBUTING.md)

											
										
										
											2020-07-02 15:35:29 +03:00
+. Pat yourself on the back and wait for your pull request to be reviewed and merged.
-												Use templated strings for better readability

											
										
										
											2020-07-22 20:07:27 +03:00
-												Add details of who will merge (CONTRIBUTING.md)

											
										
										
											2020-07-02 15:35:29 +03:00
+								If you're a GitHub staff member, you can merge your own PR once it's approved; for external contributors, GitHub staff will merge your PR once it's approved.
-												Initial commit (from f5274cbdce4ae7c9e4b937dcdf95ac70ae436d5f)

											
										
										
											2020-04-28 17:46:47 +03:00
 								Here are a few things you can do that will increase the likelihood of your pull request being accepted:
 								- Write tests.
 								- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
 								- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
 								## Resources
 								- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
 								- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
 								- [GitHub Help](https://help.github.com)