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

check docs and online help for warnings #7959

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

jodygarnett
Copy link
Contributor

I noticed a change I did failed linux build (which uses maven to call mkdocs build --strict) but passed the docs workflow check (which only uses mike).

Updated the docs workflow to use mkdocs build --strict for docs and online help (so it can act as a quick check.

Checklist

  • I have read the contribution guidelines
  • Pull request provided for main branch, backports managed with label
  • Good housekeeping of code, cleaning up comments, tests, and documentation
  • Clean commit history broken into understandable chucks, avoiding big commits with hundreds of files, cautious of reformatting and whitespace changes
  • Clean commit messages, longer verbose messages are encouraged
  • API Changes are identified in commit messages
  • Testing provided for features or enhancements using automatic tests
  • User documentation provided for new features or enhancements in manual
  • Build documentation provided for development instructions in README.md files
  • Library management using pom.xml dependency management. Update build documentation with intended library use and library tutorials or documentation

@jodygarnett
Copy link
Contributor Author

jodygarnett commented Apr 15, 2024

I am not sure on how it works for editing a github workflow? The "Documentation" workflow being edited here is not being run ...

I was able to run the workflow in my fork here: https://github.com/jodygarnett/core-geonetwork/actions/runs/8694855358

- name: deploy latest docs to gh-pages branch
if: ${{ github.event_name != 'pull_request' }}
- name: deploy main docs to gh-pages 4.4 latest
if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main'
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This line will need to be modified when backported, and when a major release is made.

I found that if: does not need the conditional ${{ syntax.

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.

None yet

1 participant