Skip to content

Consistency Check needs to be removed after template generation #284

Description

@JeffGarland

After cloning examplar and running the script and removing the cookie cutter directory, the CI will fail because the consistency check. The .yml file needs to be removed by running cookie cutter.

See this PR for an example: bemanproject/sandbox-transform_join_view#7

Activity

  1. JeffGarland commented on Jan 5, 2026

    @JeffGarland
    MemberAuthor

    Actually the issue won't exist if the .github is replaced with the cookie cutter version of the .github directory which doesn't have the file. However, that's down to cookie cutter is hoisted into the repo and we have no instructions on that.

  2. self-assigned this
    on Jan 5, 2026
  3. wusatosi commented on Jan 5, 2026

    @wusatosi
    Member

    I can take this.

  4. JeffGarland commented on Jan 5, 2026

    @JeffGarland
    MemberAuthor

    Well as I mentioned after looking again the cookie cutter subtree doesn't have the file, just the main exemplar/.github tree. So if the process was to somehow 'replace' the initial repo with the generated 'cookie-cutter' this would work -- except that you can't do that with say cp -R cookie-repo original-repo and have it tell git to remove that file. We may just need to have a 'post cookie cutter' script which does it? idk what the best approach is.

  5. wusatosi commented on Jan 5, 2026

    @wusatosi
    Member

    yes I believe this is done with a post cookie cutter script, similar facility is already introduced in #281

  6. changed the title [-]cookie cutter script needs to remove the consitency check[/-] [+]Consistency Check needs to be removed after template generation[/+] on Jan 10, 2026
  7. wusatosi commented on Jan 10, 2026

    @wusatosi
    Member

    Actually, I don't think this is the fault of the cookie cutter.
    A cookie cutter based repo won't have that workflow.
    Consistency check already takes the absent of consistency check workflow into account.
    What we need to do is to teach people how to use the cookie cutter...

  8. JeffGarland commented on Jan 10, 2026

    @JeffGarland
    MemberAuthor

    What we need to do is to teach people how to use the cookie cutter...

    Exactly! I put this issue on #196 in the roadmap project for that reason. Even I need to know how to use it.

  9. JeffGarland commented on Jan 10, 2026

    @JeffGarland
    MemberAuthor

    So @wusatosi we can probably close this issue -- I was just trying to make sure I documented all the issues that happened when following our process...

  10. ednolan commented on Jan 12, 2026

    @ednolan
    Member

    Closing this issue in the hopes that the document that resolves #196 will tell users how to avoid this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions