Update changelog and docs

Author: bigdaz

README.md

@@ -24,9 +24,19 @@ apply plugin: GitHubDependencyGraphPlugin
 ```
 
 This causes 2 separate plugins to be applied, that can be used independently:
-- `GitHubDependencyExtractorPlugin` collects all dependencies that are resolved during a build execution and writes these to a file. The output file can be found at `<root>/build/reports/github-depenency-graph-gradle-plugin/github-dependency-snapshot.json`.
+- `GitHubDependencyExtractorPlugin` collects all dependencies that are resolved during a build execution and writes these to a file. The output file can be found at `<root>/build/reports/github-depenency-graph-snapshots/<job-correlator>.json`.
 - `ForceDependencyResolutionPlugin` creates a `GitHubDependencyGraphPlugin_generateDependencyGraph` task that will attempt to resolve all dependencies for a Gradle build, by simply invoking `dependencies` on all projects.
 
+### Required environment variables
+
+The following environment variables configure the snapshot generated by the `GitHubDependencyExtractorPlugin`. See the [GitHub Dependency Submission API docs](https://docs.github.com/en/rest/dependency-graph/dependency-submission?apiVersion=2022-11-28) for details:
+- `GITHUB_DEPENDENCY_GRAPH_JOB_CORRELATOR`: Sets the `job.correlator` value for the dependency submission
+- `GITHUB_DEPENDENCY_GRAPH_JOB_ID`: Sets the `job.id` value for the dependency submission
+- `GITHUB_REF`: Sets the `ref` value for the dependency submission
+- `GITHUB_SHA`: Sets the `sha` value for the dependency submission
+- `GITHUB_WORKSPACE`: Sets the root directory of the github repository
+- `GITHUB_DEPENDENCY_GRAPH_REPORT_DIR` (optional): Specifies where the dependency graph report will be generated
+
 ## Building/Testing
 
 To build and test this plugin, run the following task:

release/changes.md

@@ -1,3 +1,5 @@
 Preliminary release of the github dependency graph plugin.
 
-- Don't override the default tasks in `ForceDependencyResolutionPlugin`
+- Don't override the default tasks in `ForceDependencyResolutionPlugin`
+- Allow `job.correlator` to be specified via `GITHUB_DEPENDENCY_GRAPH_JOB_CORRELATOR` variable
+- Allow report directory to be specified via `GITHUB_DEPENDENCY_GRAPH_REPORT_DIR` variable