feat(utils): add git helper #469

BioPhoton · 2024-02-05T21:08:26Z

This PR includes utility functions related to git logic use in the future history command.

Methods included:

getCurrentBranchOrTag - The history command needs to end in the same branch where it started. This method is called before we start walking the repo history to save the "initial" branch
statusIsClean - To safely check out a branch the status needs to be clean
guardAgainstLocalChanges - the command should throw if the git status is not clean
safeCheckout - as there might be some files generated while walking the history we need to do the following:
- warn the user that the status is not clean (initial checkout)
- drop all created changes after each run

partially resolves #216

matejchalk

Sorry, but requiring a clean repository state in order to run integration tests is a hard no from a DX perspective 🙅‍♂️ Either make the tests the tests more robust, or don't test it.

packages/utils/src/lib/git.ts

packages/utils/src/lib/git.integration.test.ts

packages/utils/src/lib/git.ts

testing-utils/src/index.ts

packages/utils/src/lib/git.integration.test.ts

Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>

Co-authored-by: Katka Pilátová <katerina.pilatova@flowup.cz>

Tlacenka

Not sure which methods are needed for the history command. A brief intro in the PR description explaining the goal would be helpful. 🙏
Currently, I can only check the tests, not if the list of methods is sufficient.

Test feedback below.

packages/utils/src/lib/git.integration.test.ts

packages/utils/src/lib/git.ts

Co-authored-by: Katka Pilátová <katerina.pilatova@flowup.cz>

packages/utils/src/lib/git.integration.test.ts

packages/utils/src/lib/git.ts

Co-authored-by: Katka Pilátová <katerina.pilatova@flowup.cz>

nx-cloud · 2024-02-23T10:10:51Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 1a4206d. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 4 targets

Sent with 💌 from NxCloud.

Tlacenka

Looking good! 🧪

Added one comment but can be done in a separate PR.

packages/utils/src/lib/git.ts

feat(utils): add git helper

324262a

github-actions bot added 🔬 testing writing tests 🧩 utils labels Feb 5, 2024

github-actions bot assigned BioPhoton Feb 5, 2024

BioPhoton added 3 commits February 5, 2024 22:11

wip

59a56f4

wip

2c2f334

test(utils): fix tests

d11b939

BioPhoton marked this pull request as ready for review February 5, 2024 21:17

BioPhoton requested review from Tlacenka and matejchalk February 5, 2024 21:17

matejchalk requested changes Feb 6, 2024

View reviewed changes

Tlacenka reviewed Feb 6, 2024

View reviewed changes

BioPhoton and others added 15 commits February 6, 2024 13:02

Update packages/utils/src/lib/git.ts

6455d85

Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>

Update packages/utils/src/lib/git.ts

e7759d0

Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>

refactor(nx-plugin): fix test

8c527a0

Update packages/utils/src/lib/git.integration.test.ts

7b156f2

Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>

Update packages/utils/src/lib/git.integration.test.ts

37ea33b

Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>

Update packages/utils/src/lib/git.integration.test.ts

265321c

Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>

Update packages/utils/src/lib/git.integration.test.ts

a335de1

Co-authored-by: Katka Pilátová <katerina.pilatova@flowup.cz>

Update packages/utils/src/lib/git.ts

a8282e1

Co-authored-by: Katka Pilátová <katerina.pilatova@flowup.cz>

refactor(nx-plugin): adopt phrasing

35df331

refactor(nx-plugin): adopt comments

aa0c400

Update packages/utils/src/lib/git.integration.test.ts

faeb9cd

Co-authored-by: Katka Pilátová <katerina.pilatova@flowup.cz>

Update packages/utils/src/lib/git.integration.test.ts

8b25354

Co-authored-by: Katka Pilátová <katerina.pilatova@flowup.cz>

Update packages/utils/src/lib/git.integration.test.ts

faf5edd

Co-authored-by: Katka Pilátová <katerina.pilatova@flowup.cz>

refactor(nx-plugin): fix build

8070800

refactor(nx-plugin): format

4b7ee9a

BioPhoton mentioned this pull request Feb 6, 2024

feat(cli): add logger #459

Merged

BioPhoton added 2 commits February 6, 2024 22:05

wip

a6cc8e0

wip

b1f14e0

BioPhoton added 2 commits February 17, 2024 02:33

test(utils): add git utils tests

9a78bb6

test(utils): add git utils integration tests

b940eda

github-actions bot added the 🛠️ tooling label Feb 16, 2024

BioPhoton added 5 commits February 17, 2024 03:01

refactor(utils): format

648b73c

merge main

b971a60

test(utils): add git tests

5292e22

fix(utils): make git status clean

1c37d21

test(utils): add git helper test for empty git repo

a4d0699

BioPhoton requested a review from matejchalk February 17, 2024 17:09

fix: lint

fa39411

matejchalk previously approved these changes Feb 19, 2024

View reviewed changes

Tlacenka reviewed Feb 19, 2024

View reviewed changes

BioPhoton dismissed matejchalk’s stale review via 1435214 February 19, 2024 13:05

BioPhoton and others added 5 commits February 19, 2024 18:35

Update packages/utils/src/lib/git.ts

1435214

Co-authored-by: Katka Pilátová <katerina.pilatova@flowup.cz>

Update packages/utils/src/lib/git.integration.test.ts

b528a75

Co-authored-by: Katka Pilátová <katerina.pilatova@flowup.cz>

refactor(utils): remove isStatusClean function

6d77e3f

refactor(utils): adjust beforeEach to set up all branches

e67389a

refactor(utils): adjust error message

3541510

matejchalk previously approved these changes Feb 20, 2024

View reviewed changes

Tlacenka reviewed Feb 21, 2024

View reviewed changes

packages/utils/src/lib/git.integration.test.ts Show resolved Hide resolved

packages/utils/src/lib/git.integration.test.ts Outdated Show resolved Hide resolved

packages/utils/src/lib/git.ts Outdated Show resolved Hide resolved

BioPhoton dismissed matejchalk’s stale review via c968d70 February 23, 2024 10:10

Update packages/utils/src/lib/git.ts

c968d70

Co-authored-by: Katka Pilátová <katerina.pilatova@flowup.cz>

BioPhoton added 3 commits February 23, 2024 19:36

test(examples-plugins): refactor hooks

51984cc

fix(examples-plugins): lint

6e2cd90

Merge branch 'main' into add-git-helper

1a4206d

Tlacenka approved these changes Feb 26, 2024

View reviewed changes

packages/utils/src/lib/git.ts Show resolved Hide resolved

BioPhoton merged commit d927a61 into main Feb 26, 2024
20 checks passed

BioPhoton deleted the add-git-helper branch February 26, 2024 23:23

BioPhoton mentioned this pull request Mar 5, 2024

feat(cli): add history command #273

Merged

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(utils): add git helper #469

feat(utils): add git helper #469

BioPhoton commented Feb 5, 2024 •

edited

Loading

matejchalk left a comment

Tlacenka left a comment

nx-cloud bot commented Feb 23, 2024 •

edited

Loading

Tlacenka left a comment

feat(utils): add git helper #469

feat(utils): add git helper #469

Conversation

BioPhoton commented Feb 5, 2024 • edited Loading

matejchalk left a comment

Choose a reason for hiding this comment

Tlacenka left a comment

Choose a reason for hiding this comment

nx-cloud bot commented Feb 23, 2024 • edited Loading

☁️ Nx Cloud Report

Tlacenka left a comment

Choose a reason for hiding this comment

BioPhoton commented Feb 5, 2024 •

edited

Loading

nx-cloud bot commented Feb 23, 2024 •

edited

Loading