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.

Sign up for GitHub

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

Jump to bottom

Better reporting of readme generation errors #479

Merged
merged 1 commit into from
Aug 12, 2024
Merged

Better reporting of readme generation errors #479

merged 1 commit into from
Aug 12, 2024

Conversation

rossgray
Copy link
Contributor

Pull request outline

Generating the README can sometimes fail, as it is parsed as a Python template string. Here we add better reporting of errors to make it easier to resolve these.

Example of new error:

❯ pipeline container push
Pipeline 10:13:00 - [ERROR]: Failed to generate README: KeyError('hmm')
You may need to escape certain characters, eg change `{ }` to `{{ }}`

Checklist:

  • Version bumped

@linear Linear
Copy link

linear bot commented Aug 12, 2024

PC-1179 Fix issue with README generation failing

plutopulp
plutopulp approved these changes Aug 12, 2024
View reviewed changes
Copy link
Contributor

@plutopulp plutopulp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@rossgray rossgray merged commit 4cd79ee into main Aug 12, 2024
5 checks passed
@rossgray rossgray deleted the ross/pc-1179-fix-issue-with-readme-generation-failing branch August 12, 2024 11:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@plutopulp plutopulp plutopulp approved these changes

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@rossgray @plutopulp