Skip to content

fix(utils): replace misleading commit labels in markdown diff #945

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
matejchalk merged 1 commit into from
Feb 21, 2025
Merged

fix(utils): replace misleading commit labels in markdown diff #945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion e2e/ci-e2e/tests/__snapshots__/basic-report-diff.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Code PushUp

🥳 Code PushUp report has **improved** – compared target commit `<commit-sha>` with source commit `<commit-sha>`.
🥳 Code PushUp report has **improved** – compared current commit `<commit-sha>` with previous commit `<commit-sha>`.

<details>
<summary>👍 <strong>1</strong> audit improved</summary>
Expand Down
2 changes: 1 addition & 1 deletion e2e/ci-e2e/tests/__snapshots__/npm-workspaces-report-diff.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Code PushUp

🥳 Code PushUp report has **improved** – compared target commit `<commit-sha>` with source commit `<commit-sha>`.
🥳 Code PushUp report has **improved** – compared current commit `<commit-sha>` with previous commit `<commit-sha>`.

## 💼 Project `@example/core`

Expand Down
2 changes: 1 addition & 1 deletion e2e/ci-e2e/tests/__snapshots__/nx-monorepo-report-diff.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Code PushUp

🤨 Code PushUp report has both **improvements and regressions** – compared target commit `<commit-sha>` with source commit `<commit-sha>`.
🤨 Code PushUp report has both **improvements and regressions** – compared current commit `<commit-sha>` with previous commit `<commit-sha>`.

## 💼 Project `api`

Expand Down
2 changes: 1 addition & 1 deletion e2e/cli-e2e/tests/__snapshots__/compare.report-diff.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Code PushUp

🥳 Code PushUp report has **improved** – compared target commit `<commit-sha>` with source commit `<commit-sha>`.
🥳 Code PushUp report has **improved** – compared current commit `<commit-sha>` with previous commit `<commit-sha>`.

## 🏷️ Categories

Expand Down
2 changes: 1 addition & 1 deletion packages/utils/src/lib/reports/__snapshots__/report-diff-added.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Code PushUp

😟 Code PushUp report has **regressed** – compared target commit 0123456789abcdef0123456789abcdef01234567 with source commit abcdef0123456789abcdef0123456789abcdef01.
😟 Code PushUp report has **regressed** – compared current commit 0123456789abcdef0123456789abcdef01234567 with previous commit abcdef0123456789abcdef0123456789abcdef01.

## 🏷️ Categories

Expand Down
2 changes: 1 addition & 1 deletion packages/utils/src/lib/reports/__snapshots__/report-diff-changed.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Code PushUp

🤨 Code PushUp report has both **improvements and regressions** – compared target commit 0123456789abcdef0123456789abcdef01234567 with source commit abcdef0123456789abcdef0123456789abcdef01.
🤨 Code PushUp report has both **improvements and regressions** – compared current commit 0123456789abcdef0123456789abcdef01234567 with previous commit abcdef0123456789abcdef0123456789abcdef01.

## 🏷️ Categories

Expand Down
2 changes: 1 addition & 1 deletion packages/utils/src/lib/reports/__snapshots__/report-diff-improved.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Code PushUp

🥳 Code PushUp report has **improved** – compared target commit 0123456789abcdef0123456789abcdef01234567 with source commit abcdef0123456789abcdef0123456789abcdef01.
🥳 Code PushUp report has **improved** – compared current commit 0123456789abcdef0123456789abcdef01234567 with previous commit abcdef0123456789abcdef0123456789abcdef01.

## 🏷️ Categories

Expand Down
2 changes: 1 addition & 1 deletion packages/utils/src/lib/reports/__snapshots__/report-diff-many-audits.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Code PushUp

😟 Code PushUp report has **regressed** – compared target commit 0123456789abcdef0123456789abcdef01234567 with source commit abcdef0123456789abcdef0123456789abcdef01.
😟 Code PushUp report has **regressed** – compared current commit 0123456789abcdef0123456789abcdef01234567 with previous commit abcdef0123456789abcdef0123456789abcdef01.

<details>
<summary>👎 <strong>123</strong> audits regressed</summary>
Expand Down
2 changes: 1 addition & 1 deletion packages/utils/src/lib/reports/__snapshots__/report-diff-minimal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Code PushUp

😟 Code PushUp report has **regressed** – compared target commit 0123456789abcdef0123456789abcdef01234567 with source commit abcdef0123456789abcdef0123456789abcdef01.
😟 Code PushUp report has **regressed** – compared current commit 0123456789abcdef0123456789abcdef01234567 with previous commit abcdef0123456789abcdef0123456789abcdef01.

<details>
<summary>👎 <strong>1</strong> audit regressed</summary>
Expand Down
2 changes: 1 addition & 1 deletion packages/utils/src/lib/reports/__snapshots__/report-diff-mixed.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Code PushUp

🤨 Code PushUp report has both **improvements and regressions** – compared target commit 0123456789abcdef0123456789abcdef01234567 with source commit abcdef0123456789abcdef0123456789abcdef01.
🤨 Code PushUp report has both **improvements and regressions** – compared current commit 0123456789abcdef0123456789abcdef01234567 with previous commit abcdef0123456789abcdef0123456789abcdef01.

## 🏷️ Categories

Expand Down
2 changes: 1 addition & 1 deletion packages/utils/src/lib/reports/__snapshots__/report-diff-monorepo-changed.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Code PushUp

🤨 Code PushUp report has both **improvements and regressions** – compared target commit 0123456789abcdef0123456789abcdef01234567 with source commit abcdef0123456789abcdef0123456789abcdef01.
🤨 Code PushUp report has both **improvements and regressions** – compared current commit 0123456789abcdef0123456789abcdef01234567 with previous commit abcdef0123456789abcdef0123456789abcdef01.

## 💼 Project `web`

Expand Down
2 changes: 1 addition & 1 deletion packages/utils/src/lib/reports/__snapshots__/report-diff-monorepo-unchanged.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Code PushUp

😐 Code PushUp report is **unchanged** – compared target commit 0123456789abcdef0123456789abcdef01234567 with source commit abcdef0123456789abcdef0123456789abcdef01.
😐 Code PushUp report is **unchanged** – compared current commit 0123456789abcdef0123456789abcdef01234567 with previous commit abcdef0123456789abcdef0123456789abcdef01.

---

Expand Down
2 changes: 1 addition & 1 deletion packages/utils/src/lib/reports/__snapshots__/report-diff-monorepo-with-portal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Code PushUp

🥳 Code PushUp report has **improved** – compared target commit 0123456789abcdef0123456789abcdef01234567 with source commit abcdef0123456789abcdef0123456789abcdef01.
🥳 Code PushUp report has **improved** – compared current commit 0123456789abcdef0123456789abcdef01234567 with previous commit abcdef0123456789abcdef0123456789abcdef01.

## 💼 Project `frontoffice`

Expand Down
2 changes: 1 addition & 1 deletion packages/utils/src/lib/reports/__snapshots__/report-diff-monorepo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Code PushUp

🤨 Code PushUp report has both **improvements and regressions** – compared target commit 0123456789abcdef0123456789abcdef01234567 with source commit abcdef0123456789abcdef0123456789abcdef01.
🤨 Code PushUp report has both **improvements and regressions** – compared current commit 0123456789abcdef0123456789abcdef01234567 with previous commit abcdef0123456789abcdef0123456789abcdef01.

## 💼 Project `console`

Expand Down
2 changes: 1 addition & 1 deletion packages/utils/src/lib/reports/__snapshots__/report-diff-unchanged.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Code PushUp

😐 Code PushUp report is **unchanged** – compared target commit 0123456789abcdef0123456789abcdef01234567 with source commit abcdef0123456789abcdef0123456789abcdef01.
😐 Code PushUp report is **unchanged** – compared current commit 0123456789abcdef0123456789abcdef01234567 with previous commit abcdef0123456789abcdef0123456789abcdef01.

## 🏷️ Categories

Expand Down
2 changes: 1 addition & 1 deletion packages/utils/src/lib/reports/__snapshots__/report-diff-with-portal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Code PushUp

🤨 Code PushUp report has both **improvements and regressions** – compared target commit 0123456789abcdef0123456789abcdef01234567 with source commit abcdef0123456789abcdef0123456789abcdef01.
🤨 Code PushUp report has both **improvements and regressions** – compared current commit 0123456789abcdef0123456789abcdef01234567 with previous commit abcdef0123456789abcdef0123456789abcdef01.

[🕵️ See full comparison in Code PushUp portal 🔍](https://app.code-pushup.dev/portal/dunder-mifflin/website/comparison/abcdef0123456789abcdef0123456789abcdef01/0123456789abcdef0123456789abcdef01234567)

Expand Down
2 changes: 1 addition & 1 deletion packages/utils/src/lib/reports/generate-md-reports-diff-utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ export function formatReportOutcome(
};

if (commits) {
const commitsText = `compared target commit ${commits.after.hash} with source commit ${commits.before.hash}`;
const commitsText = `compared current commit ${commits.after.hash} with previous commit ${commits.before.hash}`;
return md`${outcomeTexts[outcome]} – ${commitsText}.`;
}

Expand Down