Skip to content

Conversation

pavoljuhas
Copy link
Collaborator

While most build directories are generated and should be ignored,
docs/build has legitimate sources and should be tracked.

Also ignore the out/ directory only at the repository root.

While most `build` directories are generated and should be ignored,
`docs/build` has legitimate sources and should be tracked.

Also ignore the `out/` directory only at the repository root.
@pavoljuhas pavoljuhas requested review from a team and vtomole as code owners April 2, 2025 19:50
@mhucka
Copy link
Contributor

mhucka commented Apr 2, 2025

Oh, wow, good catch. I wonder how long docs/build has been ignored :-)

@mhucka
Copy link
Contributor

mhucka commented Apr 2, 2025

@pavoljuhas is it possible that cirq-web/cirq_ts/build/ is another case that shouldn't be ignored? Never mind – I see now that it's a generated directory and not something in the git repo.

Copy link

codecov bot commented Apr 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.14%. Comparing base (c34989b) to head (521e434).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #7216   +/-   ##
=======================================
  Coverage   98.14%   98.14%           
=======================================
  Files        1104     1104           
  Lines       96352    96352           
=======================================
  Hits        94569    94569           
  Misses       1783     1783           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@pavoljuhas
Copy link
Collaborator Author

Oh, wow, good catch. I wonder how long docs/build has been ignored :-)

It was not quite ignored, but in a recent change I had git add file complaining the file is matched by some ignore pattern. This also helps to discover any clutter files created in docs/build.

@pavoljuhas
Copy link
Collaborator Author

Verified this is the only misignored directory by getting empty output from

git ls-files | sed "s,[^/]\+$,do-not-ignore-me," | uniq | git check-ignore --stdin

The output at c34989b is

docs/build/do-not-ignore-me

@pavoljuhas pavoljuhas added this pull request to the merge queue Apr 2, 2025
Merged via the queue into quantumlib:main with commit b0a740c Apr 2, 2025
40 checks passed
@pavoljuhas pavoljuhas deleted the improve-gitignore branch April 2, 2025 20:37
@mhucka mhucka changed the title Fix gitignore to track maintained sources in docs/build Fix top-level .gitignore file to track (not ignore) files in docs/build Apr 8, 2025
BichengYing pushed a commit to BichengYing/Cirq that referenced this pull request Jun 20, 2025
)

While most `build` directories are generated and should be ignored,
`docs/build` has legitimate sources and should be tracked.

Also ignore the `out/` directory only at the repository root.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants