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

docs(config): warn about spaces in schedule #29121

Merged

Conversation

HonkingGoose
Copy link
Collaborator

Changes

  • Warn users that in the schedule config option:
    • 5am is correct
    • 5 am (with space) is wrong

Context

@rarkins fixed a repository configuration error, they were using a space between 4 and am:

The schedule docs only show examples of the correct format, but it's easy to assume that 4 am will work. Or to accidentally add a space, because that feels natural.

I think we should warn louder about this possible gotcha. 😄

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

@viceice viceice changed the title docs(config options): warn about spaces in schedule docs(config): warn about spaces in schedule May 16, 2024
@rarkins
Copy link
Collaborator

rarkins commented May 16, 2024

Could we massage this instead?

@viceice
Copy link
Member

viceice commented May 17, 2024

Could we massage this instead?

I'm not sure, it can probably break some other scenarios

@rarkins rarkins added this pull request to the merge queue May 17, 2024
Merged via the queue into renovatebot:main with commit ebfb48d May 17, 2024
37 checks passed
@HonkingGoose HonkingGoose deleted the docs/keep-number-and-am-pm-together branch May 17, 2024 09:12
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 37.368.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 18, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants