Skip to content
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.

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

Move files that are not golden files into input directory #327

Conversation

newhoggy
Copy link
Contributor

@newhoggy newhoggy commented Oct 3, 2023

Changelog

- description: |
    Move files that are not golden files into `input` directory
# uncomment types applicable to the change:
  type:
  # - feature        # introduces a new feature
  # - breaking       # the API has changed in a breaking way
  - compatible     # the API has changed but is non-breaking
  # - optimisation   # measurable performance improvements
  - improvement    # QoL changes e.g. refactoring
  # - bugfix         # fixes a defect
  # - test           # fixes/modifies tests
  # - maintenance    # not directly related to the code
  # - release        # related to a new release preparation
  # - documentation  # change in code docs, haddocks...

Context

Golden files are only those files that can be generated with CREATE_GOLDEN_FILES=1.

Any other files are not golden files and should go elsewhere. For example input files should go in the input directory.

The benefit of this split is that you could rm -rf the golden directory knowing all the files within can be regenerated. This is a good way to figure out if any golden files are not longer in use.

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • The change log section in the PR description has been filled in
  • New tests are added if needed and existing tests are updated. These may include:
    • golden tests
    • property tests
    • round trip tests
    • integration tests
      See Running tests for more details
  • The version bounds in .cabal files are updated
  • CI passes. See note on CI. The following CI checks are required:
    • Code is linted with hlint. See .github/workflows/check-hlint.yml to get the hlint version
    • Code is formatted with stylish-haskell. See .github/workflows/stylish-haskell.yml to get the stylish-haskell version
    • Code builds on Linux, MacOS and Windows for ghc-8.10.7 and ghc-9.2.7
  • The changelog section in the PR is updated to describe the change
  • Self-reviewed the diff

@newhoggy newhoggy marked this pull request as ready for review October 3, 2023 10:52
@newhoggy newhoggy force-pushed the newhoggy/move-files-that-are-not-golden-files-to-input-directory branch from 187688f to 21ead94 Compare October 3, 2023 11:00
@newhoggy
Copy link
Contributor Author

newhoggy commented Oct 3, 2023

Yeah, those are annoying. The don't meet the criteria to be called golden (ie then don't regenerate), but they call themselves golden.

@newhoggy
Copy link
Contributor Author

newhoggy commented Oct 3, 2023

I'll see if I can convert them to actually be golden.

@newhoggy newhoggy force-pushed the newhoggy/move-files-that-are-not-golden-files-to-input-directory branch 2 times, most recently from ac11272 to aac161a Compare October 3, 2023 12:45
@newhoggy
Copy link
Contributor Author

newhoggy commented Oct 3, 2023

I fixed the ones I could and renamed the rest to not be golden.

@newhoggy newhoggy requested a review from carbolymer October 3, 2023 12:45
@newhoggy newhoggy force-pushed the newhoggy/move-files-that-are-not-golden-files-to-input-directory branch from aac161a to b2275d0 Compare October 4, 2023 11:42
@newhoggy newhoggy force-pushed the newhoggy/move-files-that-are-not-golden-files-to-input-directory branch from b2275d0 to d52b178 Compare October 5, 2023 10:39
@newhoggy newhoggy enabled auto-merge October 5, 2023 10:39
@newhoggy newhoggy added this pull request to the merge queue Oct 5, 2023
Merged via the queue into main with commit e86c152 Oct 5, 2023
19 checks passed
@newhoggy newhoggy deleted the newhoggy/move-files-that-are-not-golden-files-to-input-directory branch October 5, 2023 11:11
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.

3 participants