Skip to content

Make the check changelog message more explicit #20911

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

Merged
merged 1 commit into from
Sep 2, 2021
Merged

Make the check changelog message more explicit #20911

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 18 additions & 5 deletions .github/workflows/check-changelog.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,27 @@ jobs:
else
echo "Changelog and milestone do not correspond."
echo "If you see this error make sure that the tagged milestone for the PR"
echo "and the changelog name properly match."
echo "and the edited changelog filename properly match."
exit 1
fi
fi
else
echo "Changelog entry is missing."
echo "If you see this error and there is already a changelog entry then make sure that"
echo "the PR number is correct. If no changelog entry is required for this PR,"
echo "label the PR with 'No Changelog Needed' to bypass this check."
echo "A Changelog entry is missing."
echo ""
echo "Please add an entry to the changelog at 'doc/whats_new/v*.rst'"
echo "to document your change assuming that the PR will be merged"
echo "in time for the next release of scikit-learn."
echo ""
echo "Look at other entries in that file for inspiration and please"
echo "reference this pull request using the ':pr:' directive and"
echo "credit yourself (and other contributors if applicable) with"
echo "the ':user:' directive."
echo ""
echo "If you see this error and there is already a changelog entry,"
echo "check that the PR number is correct."
echo ""
echo" If you believe that this PR does no warrant a changelog"
echo "entry, say so in a comment so that a maintainer will label "
echo "the PR with 'No Changelog Needed' to bypass this check."
exit 1
fi