Skip to content

Commit 96b1ad3

Browse files
committed
Improve section titles in documentation
1 parent 7dcdc89 commit 96b1ad3

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ The process involves three steps:
1414
<!-- TOC -->
1515

1616
- [Table of Contents](#table-of-contents)
17-
- [:rocket: Pipeline for TypeScript Code](#rocket-pipeline-for-typescript-code)
18-
- [:coffee: Pipeline for Java Artifacts](#coffee-pipeline-for-java-artifacts)
19-
- [:bookmark_tabs: CSV Cypher Query Report Reference](#bookmark_tabs-csv-cypher-query-report-reference)
17+
- [:rocket: TypeScript Code Pipeline](#rocket-typescript-code-pipeline)
18+
- [:coffee: Java Artifacts Pipeline](#coffee-java-artifacts-pipeline)
19+
- [:bookmark_tabs: CSV Report Reference](#bookmark_tabs-csv-report-reference)
2020
- [:notebook: Jupyter Notebook Report Reference](#notebook-jupyter-notebook-report-reference)
2121
- [:framed_picture: Image Reference](#framed_picture-image-reference)
22-
- [:recycle: Keeping the Analysis Workflow Updated with Renovate](#recycle-keeping-the-analysis-workflow-updated-with-renovate)
22+
- [:recycle: Update Analysis Workflow with Renovate](#recycle-update-analysis-workflow-with-renovate)
2323
- [:page_facing_up: License](#page_facing_up-license)
2424
- [:bar_chart: Analysis Results](#bar_chart-analysis-results)
2525
- [External Dependencies of Java Packages](#external-dependencies-of-java-packages)
@@ -35,26 +35,26 @@ The process involves three steps:
3535

3636
<!-- /TOC -->
3737

38-
## :rocket: Pipeline for TypeScript Code
38+
## :rocket: TypeScript Code Pipeline
3939

4040
This example demonstrates how to analyze TypeScript code in a GitHub Workflows pipeline.
4141

4242
1. The first job, [prepare-code-to-analyze](https://github.com/JohT/code-graph-analysis-examples/blob/23143b34d8fc6e0ab7d80102d8de0b6e6a4ec98e/.github/workflows/typescript-code-analysis.yml#L40), in the GitHub Actions Workflow [typescript-code-analysis.yml](https://github.com/JohT/code-graph-analysis-examples/blob/23143b34d8fc6e0ab7d80102d8de0b6e6a4ec98e/.github/workflows/typescript-code-analysis.yml), shows how to extract TypeScript code from a repository and upload it for analysis.
4343

4444
2. The second job, [analyze-code-graph](https://github.com/JohT/code-graph-analysis-examples/blob/23143b34d8fc6e0ab7d80102d8de0b6e6a4ec98e/.github/workflows/typescript-code-analysis.yml#L89), calls the shared analysis workflows using the uploaded artifacts' names as parameters. Here is a simple example:
4545

46-
```yaml
47-
name: Analyze Code Graph
48-
needs: [prepare-code-to-analyze]
49-
uses: JohT/code-graph-analysis-pipeline/.github/workflows/public-analyze-code-graph.yml
50-
with:
51-
analysis-name: ${{ needs.prepare-code-to-analyze.outputs.analysis-name }}
52-
sources-upload-name: ${{ needs.prepare-code-to-analyze.outputs.sources-upload-name }}
53-
```
46+
```yaml
47+
name: Analyze Code Graph
48+
needs: [prepare-code-to-analyze]
49+
uses: JohT/code-graph-analysis-pipeline/.github/workflows/public-analyze-code-graph.yml
50+
with:
51+
analysis-name: ${{ needs.prepare-code-to-analyze.outputs.analysis-name }}
52+
sources-upload-name: ${{ needs.prepare-code-to-analyze.outputs.sources-upload-name }}
53+
```
5454
5555
3. The third job, [analyze-code-graph](https://github.com/JohT/code-graph-analysis-examples/blob/23143b34d8fc6e0ab7d80102d8de0b6e6a4ec98e/.github/workflows/typescript-code-analysis.yml#L99), demonstrates how to download the analysis results and commit them back to the repository.
5656
57-
## :coffee: Pipeline for Java Artifacts
57+
## :coffee: Java Artifacts Pipeline
5858
5959
Java artifacts are analyzed similarly to TypeScript code. The main difference is that Java artifacts are downloaded from a Maven repository instead of being part of the repository.
6060
@@ -64,7 +64,7 @@ The first job, [prepare-code-to-analyze](https://github.com/JohT/code-graph-anal
6464
6565
The second and third jobs are the same as for the TypeScript example.
6666
67-
## :bookmark_tabs: CSV Cypher Query Report Reference
67+
## :bookmark_tabs: CSV Report Reference
6868
6969
[CSV_REPORTS.md](./analysis-results/CSV_REPORTS.md) lists all CSV Cypher query result reports inside the [results](./results) directory. It can be generated as described in [Generate CSV Report Reference](./COMMANDS.md#generate-csv-cypher-query-report-reference).
7070
@@ -76,7 +76,7 @@ The second and third jobs are the same as for the TypeScript example.
7676
7777
[IMAGES.md](./analysis-results/IMAGES.md) lists all PNG images inside the [results](./results) directory. It can be generated as described in [Generate Image Reference](./COMMANDS.md#generate-image-reference).
7878
79-
## :recycle: Keeping the Analysis Workflow Updated with Renovate
79+
## :recycle: Update Analysis Workflow with Renovate
8080
8181
This repository uses [Renovate](https://docs.renovatebot.com) to automatically update the analysis workflow to the latest version. To enable this, add the following extension to your Renovate configuration:
8282

0 commit comments

Comments
 (0)