Updating changelog check to include the docs/ dir #264
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alisonlhart
force-pushed
the
changelog-docs
branch
2 times, most recently
from
f093b97 to
e890573
Compare
Issue: AAH-3083
alisonlhart
force-pushed
the
changelog-docs
branch
from
e890573 to
47b874e
Compare
|
Ready to merge unless there are reviewer concerns. |
jctanner
approved these changes
Feb 6, 2024
bmclaughlin
approved these changes
Feb 6, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue: AAH-3083
Update the changelog check to look under the
docs/dir as well as the collection root for a changelog file, in case maintainers want to display their changelog.md files in the Galaxy UI ("Documentation") tab, or just want to store their changelog files underdocs/.Also add the ability to turn this check off by adding a config value, defaulting to
Truesince this check was already running on all imports previously.Also add a section to the README "Additional Notes", with info about .md files (or HTML render-able files) in the
docs/dir displaying in the "Documentation" tab on Galaxy and Automation Hub.