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

Add towncrier files to ignore or rename .keep #6225

Closed
stevepiercy opened this issue Aug 1, 2024 · 6 comments · Fixed by #6232
Closed

Add towncrier files to ignore or rename .keep #6225

stevepiercy opened this issue Aug 1, 2024 · 6 comments · Fixed by #6232
Assignees

Comments

@stevepiercy
Copy link
Collaborator

stevepiercy commented Aug 1, 2024

From a release on July 29, 2024, we need to either rename all towncrier fragments that we want to ignore to .keep or add .gitkeep to towncrier's new ignore configuration.

Reference: twisted/towncrier#622

@Tishasoumya-02 I know it's not your fault but the pull request isn't green
https://github.com/plone/volto/actions/runs/10196668962/job/28207886197?pr=6147
Due to
https://github.com/twisted/towncrier/blob/trunk/src/towncrier/_builder.py#L117

try to rename package/volto/news/.gitkeep to .keep as they recognize that as something to ignore.

Originally posted by @ichim-david in #6147 (comment)

@ichim-david
Copy link
Member

ichim-david commented Aug 1, 2024

@stevepiercy .gitkeep is a convention there isn't anything magical about it's naming other than to be more clear that it's for git to keep the folder from deleting if it were empty.

I opted to suggest to simply rename to .keep for plone/volto but as part as another pull request for this issue we could add .gitkeep as an ignore option to each package from the monorepo that uses towncrier if someone is willing todo it and contribute as a way to fix this issue this way.

@stevepiercy
Copy link
Collaborator Author

.gitkeep is used in every Plone repo I have seen so far. I'm actually surprised that this was included in the default list of ignored files in the upstream package. I think I'll make an issue and submit a PR with the suggestion, so that we don't have to make dozens of changes to comply with this change. It would be backward compatible.

@wesleybl
Copy link
Member

wesleybl commented Aug 2, 2024

I think I'll make an issue and submit a PR with the suggestion

@stevepiercy Yes! .gitkeep is very common. It shouldn't be a problem for towncrier.

@stevepiercy
Copy link
Collaborator Author

stevepiercy commented Aug 2, 2024

Issue created at twisted/towncrier#643 with offer to submit PR, if the maintainers agree.

@stevepiercy stevepiercy self-assigned this Aug 2, 2024
@stevepiercy
Copy link
Collaborator Author

PR merged twisted/towncrier#647.

Awaiting release to revert the file rename.

@stevepiercy
Copy link
Collaborator Author

Towncrier 24.8.0 was released today, and I merged the #6232.

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

Successfully merging a pull request may close this issue.

3 participants