Skip to content

Commit d165f87

Browse files
fix: restore Vale workflow and dynamic dedup TOC (#844)
* ci: restore Vale lint workflow scope Revert the docs PR workflow change so Vale uses the repository's existing versioned_docs scope. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com> * docs: restore dynamic dedup TOC headings Make Go and Java step headings use the same level. This restores side table entries without changing the content. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com> --------- Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
1 parent 6ef2e20 commit d165f87

2 files changed

Lines changed: 6 additions & 19 deletions

File tree

.github/workflows/vale-lint-action.yml

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,18 @@ jobs:
88
runs-on: ubuntu-latest
99
steps:
1010
- uses: actions/checkout@v4.1.1
11-
with:
12-
fetch-depth: 0
13-
14-
- name: Collect changed docs
15-
id: changed-docs
16-
shell: bash
17-
run: |
18-
files=$(git diff --name-only --diff-filter=ACMRT "${{ github.event.pull_request.base.sha }}" "${{ github.sha }}" -- 'versioned_docs/**/*.md' | paste -sd, -)
19-
echo "files=${files}" >> "$GITHUB_OUTPUT"
2011

2112
# Set up Vale Action — only lint changed lines to avoid flagging pre-existing issues.
2213
- uses: errata-ai/vale-action@v2.1.1
23-
if: steps.changed-docs.outputs.files != ''
2414
with:
2515
# Only check lines added/modified in the PR diff.
2616
filter_mode: diff_context
2717
# Set the reporter to display the output
2818
reporter: github-pr-check
2919
# Fails the action if there are errors
3020
fail_on_error: true
31-
# Lint only changed versioned docs. The action fails on all Vale output
32-
# before reviewdog filters annotations, so a broad directory here makes
33-
# pre-existing docs issues fail unrelated PRs.
34-
files: ${{ steps.changed-docs.outputs.files }}
35-
separator: ','
21+
# Lint docs across all versioned directories
22+
files: 'versioned_docs'
3623
# Specify the Vale version
3724
version: 3.0.3
3825
env:

versioned_docs/version-4.0.0/keploy-cloud/deduplication.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ keploy test -c "docker compose up" --containerName containerName --dedup
3838

3939
### For Golang Applications
4040

41-
**1. Pre-requisite**
41+
#### 1. Pre-requisite
4242

4343
Install the `keploy/go-sdk/v3/keploy` : -
4444

@@ -52,15 +52,15 @@ Add the following on top of your main application file : -
5252
import _ "github.com/keploy/go-sdk/v3/keploy"
5353
```
5454

55-
**2. Build Configuration**
55+
#### 2. Build Configuration
5656

5757
Update the `go build` command in your Dockerfile (or native build script) to include coverage flags. These are required for deduplication to calculate coverage accurately.
5858

5959
```bash
6060
RUN go build -cover -covermode=atomic -coverpkg=./... -o /app/main .
6161
```
6262

63-
**3. Dockerfile Configuration (Important for Docker Users)**
63+
#### 3. Dockerfile Configuration (Important for Docker Users)
6464

6565
If you are using a multi-stage Docker build (e.g., building in one stage and running in a slim image), you **must** ensure the Go toolchain and `go.mod` files are preserved in the final runtime image. The deduplication feature requires access to the Go runtime to map coverage data correctly.
6666

@@ -87,7 +87,7 @@ ENV GOMOD=/app/go.mod
8787

8888
> **Note:** If you face issues with toolchain downloads in restricted environments, you may also need to set `ENV GOTOOLCHAIN=local` and configure your `GOPROXY` in the Dockerfile.
8989
90-
**4. Run Deduplication**
90+
#### 4. Run Deduplication
9191

9292
For Docker, run:
9393

0 commit comments

Comments
 (0)