Summary

Multiple documentation fixes, adds the right version to the program from package.json when --version is used.

Changelog

• #29 Get version number from package.json - @kyanny
• #28 Get version number from package.json - @dependabot
• #26 Add npm install instruction at the Running the CLI section - @kyanny
• #25 Fix node command example of the README.md - @kyanny
• #24 Fix git clone URL of the README.md - @kyanny

Summary

Fixes some issues on the workflows to use the CLI for reporting and patches the latest vulnerabilities reported. Also fixes a problem with the regex that made certain cursors fail

Changelog

• #23 Fix LAST_CURSOR check logic - @ffalor
• #22 Fix .gitignore conflict with workflow step - @ffalor
• #21 Fixing Regex to match all cursor events - @ax-tbowyer

• Adds support for Enterprise the audit log API #20

Update token regex

• Adds the new regex for the new token format
• Improves documentation

Support for REST Audit Log API

In this version we've added two new options in the CLI to use the REST API or GraphQL depending on the needs.

--api v3|v4
--api-type all|git|web (only for v3)

Support for files and worflow

Adds support to report the content of the audit log into a file. This also includes a GitHub actions workflow that you can copy and use in your repositories to send the audit log somewhere

Enhancements

Adds the limit parameter to the script to set a maximum number of items retrieved by the audit #3

BUGFIX: replaces the cursor implementation with an implementation using the id of the items.

Explanation:
Cursors in GitHub implementation are not unique as they contain just the position. Because of that we cannot rely on them as unique identifiers and we need to use the node id. Now this version uses the unique node id to get the information.

Initial release with support for:

  -v, --version            Output the current version
  -t, --token <string>     the token to access the API (mandatory)
  -o, --org <string>       the organization we want to extract the audit log from
  -cfg, --config <string>  location for the config yaml file. Default ".ghec-audit-log" (default: "./.ghec-audit-log")
  -p, --pretty             prints the json data in a readable format (default: false)
  -c, --cursor <string>    if provided, this cursor will be used to query the newest entries from the cursor provided. If not present,
                the result will contain all the audit log from the org