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

Warn contributors: README is generated #919

Merged
merged 4 commits into from
Dec 22, 2023

Conversation

szepeviktor
Copy link
Contributor

This may help future contributors.

@@ -44,7 +44,8 @@ final class ReadmeCommand extends Command
protected function execute(InputInterface $input, OutputInterface $output): int
{
$output->write(
\sprintf('# %s', self::NAME) . "\n\n"
'<!-- This files is generated by ReadmeCommand -->' . "\n\n"
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
'<!-- This files is generated by ReadmeCommand -->' . "\n\n"
'<!-- This file is generated by ReadmeCommand -->' . "\n\n"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That was my autonomous finger!

Copy link
Contributor

@localheinz localheinz Oct 21, 2023

Choose a reason for hiding this comment

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

Probably needs a rebase on top of main following #918, @szepeviktor!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think README needs to be regenerated.
I let you guys do that.

Copy link
Owner

Choose a reason for hiding this comment

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

I think README needs to be regenerated.

That wouldn't be enough, as analyse job is failing with code style violation. Also, that comment won't be displayed: https://github.com/6b7562617765726c6f73/php-cs-fixer-custom-fixers/tree/test_readme_with_html_comment

I believe the problem is NOT that README.md is generated, but not checking failing CI's jobs in PR. I've added message to the check with information what to do.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed!

@coveralls
Copy link

Pull Request Test Coverage Report for Build 7302146633

Warning: This coverage report may be inaccurate.

We've detected an issue with your CI configuration that might affect the accuracy of this pull request's coverage report.
To ensure accuracy in future PRs, please see these guidelines.
A quick fix for this PR: rebase it; your next report should be accurate.

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 100.0%

Totals Coverage Status
Change from base Build 6596428390: 0.0%
Covered Lines: 2572
Relevant Lines: 2572

💛 - Coveralls

@kubawerlos kubawerlos merged commit 7b15040 into kubawerlos:main Dec 22, 2023
14 checks passed
@kubawerlos
Copy link
Owner

Thank you @szepeviktor and @localheinz

@szepeviktor
Copy link
Contributor Author

Glad to contribute.

@szepeviktor szepeviktor deleted the patch-1 branch December 22, 2023 18:00
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.

4 participants