Skip to content

add nox task for checking if the changelog got updated #346

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
Merged
Jannis-Mittenzwei merged 25 commits into from
Mar 5, 2025
Merged

add nox task for checking if the changelog got updated #346

Jannis-Mittenzwei merged 25 commits into from
Mar 5, 2025

Conversation

@Jannis-Mittenzwei
Copy link
Contributor

@Jannis-Mittenzwei Jannis-Mittenzwei commented Jan 28, 2025

closes #65

Design

test: nothing to test because it only uses Git Diff
proceed: checks the doc/changes directory for changes, if changes exitcode=0, if no changes exitcode=1

@Jannis-Mittenzwei Jannis-Mittenzwei added the feature Product feature label Jan 28, 2025
ckunki
ckunki requested changes Mar 4, 2025
View reviewed changes
@ckunki
Copy link
Contributor

ckunki commented Mar 4, 2025

As the expected behavior probably only can be verified by an integration test, with its implementation requiring significant effort, we will only do manual tests:

Please perform a last manual check:

  • Currently, in PTB the nox task is expected to report OK, changelog is updated
  • Simulate also the other case with git checkout main doc/changes
    • Now there are no changes
    • The nox task is expected to report an error

@Jannis-Mittenzwei Jannis-Mittenzwei requested a review from ckunki March 4, 2025 11:58
ckunki
ckunki previously approved these changes Mar 4, 2025
View reviewed changes
@Jannis-Mittenzwei Jannis-Mittenzwei requested a review from ckunki March 4, 2025 15:00
@Jannis-Mittenzwei Jannis-Mittenzwei merged commit 5017343 into main Mar 5, 2025
38 checks passed
@Jannis-Mittenzwei Jannis-Mittenzwei deleted the feature/#65-Add-nox-session-for-checking-if-the-changelog-got-updated branch March 5, 2025 08:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ckunki ckunki ckunki approved these changes

Assignees

@Jannis-Mittenzwei Jannis-Mittenzwei

Labels

feature Product feature

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

✨ Add nox session for checking if the changelog got updated

3 participants

@Jannis-Mittenzwei @ckunki