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

HPCC-32137 PR test for documentation builds #18858

Merged
merged 1 commit into from
Oct 4, 2024

Conversation

Michael-Gardner
Copy link
Contributor

Type of change:

  • This change is a bug fix (non-breaking change which fixes an issue).
  • This change is a new feature (non-breaking change which adds functionality).
  • This change improves the code (refactor or other change that does not change the functionality)
  • This change fixes warnings (the fix does not alter the functionality or the generated code)
  • This change is a breaking change (fix or feature that will cause existing behavior to change).
  • This change alters the query API (existing queries will have to be recompiled)

Checklist:

  • My code follows the code style of this project.
    • My code does not create any new warnings from compiler, build system, or lint.
  • The commit message is properly formatted and free of typos.
    • The commit message title makes sense in a changelog, by itself.
    • The commit is signed.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly, or...
    • I have created a JIRA ticket to update the documentation.
    • Any new interfaces or exported functions are appropriately commented.
  • I have read the CONTRIBUTORS document.
  • The change has been fully tested:
    • I have added tests to cover my changes.
    • All new and existing tests passed.
    • I have checked that this change does not introduce memory leaks.
    • I have used Valgrind or similar tools to check for potential issues.
  • I have given due consideration to all of the following potential concerns:
    • Scalability
    • Performance
    • Security
    • Thread-safety
    • Cloud-compatibility
    • Premature optimization
    • Existing deployed queries will not be broken
    • This change fixes the problem, not just the symptom
    • The target branch of this pull request is appropriate for such a change.
  • There are no similar instances of the same problem that should be addressed
    • I have addressed them here
    • I have raised JIRA issues to address them separately
  • This is a user interface / front-end modification
    • I have tested my changes in multiple modern browsers
    • The component(s) render as expected

Smoketest:

  • Send notifications about my Pull Request position in Smoketest queue.
  • Test my draft Pull Request.

Testing:

Copy link

github-actions bot commented Jul 8, 2024

Jira Issue: https://hpccsystems.atlassian.net//browse/HPCC-32137

Jirabot Action Result:
Workflow Transition: Merge Pending
Updated PR

@Michael-Gardner Michael-Gardner force-pushed the HPCC-32137 branch 11 times, most recently from 51145ee to 8dd2159 Compare July 9, 2024 16:42
@Michael-Gardner Michael-Gardner changed the base branch from master to candidate-9.6.x July 9, 2024 16:43
@Michael-Gardner
Copy link
Contributor Author

@GordonSmith apologies for all the pushes on this PR. This allows us to run a documentation build check based on changes to the docs/ directory whenever we do a PR. The called workflow also allows for @JamesDeFabia and @g-pan to manually build any changes over on their local repository (9.6+) before they put up a PR.

The dorny/paths-filter@v3 action was used because the built in "paths:" filter only works on github events and not on the Jobs/steps phase.

.github/workflows/build-vcpkg.yml Show resolved Hide resolved
.github/workflows/test-documentation.yml Outdated Show resolved Hide resolved
.github/workflows/test-documentation.yml Show resolved Hide resolved
.github/workflows/test-documentation.yml Show resolved Hide resolved
@ghalliday
Copy link
Member

@Michael-Gardner this seems to have stalled...

@Michael-Gardner
Copy link
Contributor Author

@ghalliday Fixing this.

@Michael-Gardner Michael-Gardner force-pushed the HPCC-32137 branch 5 times, most recently from 55e32cb to 9b05e4e Compare September 17, 2024 22:21
Copy link
Member

@GordonSmith GordonSmith left a comment

Choose a reason for hiding this comment

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

Just one suggestion and some left over testing comments?

docs/DOCUMENTATION.md Outdated Show resolved Hide resolved
.github/workflows/build-vcpkg.yml Show resolved Hide resolved
@Michael-Gardner Michael-Gardner force-pushed the HPCC-32137 branch 3 times, most recently from 9b05e4e to e58c6d1 Compare September 24, 2024 14:54
@Michael-Gardner
Copy link
Contributor Author

@GordonSmith squashed and cleaned up.

Signed-off-by: Michael Gardner <michael.gardner@lexisnexisrisk.com>
@ghalliday ghalliday merged commit 0a5cc7f into hpcc-systems:candidate-9.6.x Oct 4, 2024
54 checks passed
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.

3 participants