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.

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

HPCC-31459 Generate GitHub Action chain diagram from action (.yml) files #18887

Merged
merged 1 commit into from
Aug 8, 2024
Merged

HPCC-31459 Generate GitHub Action chain diagram from action (.yml) files #18887

merged 1 commit into from
Aug 8, 2024

Conversation

Charan-Sharan
Copy link
Contributor

@Charan-Sharan Charan-Sharan commented Jul 17, 2024 •
edited
Loading

HPCC-31459 Generate GitHub Action chain diagram from action (.yml) files
This Action workflow generates a markdown file that contains useful graphs that give a brief overview of all the GitHub Actions Workflows.

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:

@Charan-Sharan Charan-Sharan force-pushed the HPCC-31459-impl-master branch 2 times, most recently from af1d1c3 to ce8d703 Compare July 17, 2024 14:58
AttilaVamos
AttilaVamos requested changes Jul 17, 2024
View reviewed changes
Copy link
Contributor

@AttilaVamos AttilaVamos left a comment

Choose a reason for hiding this comment

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

Can you add:

  • condition for running only if action file changed
  • execute as a workflow item

@Charan-Sharan Charan-Sharan force-pushed the HPCC-31459-impl-master branch from ce8d703 to 8849c9e Compare July 18, 2024 09:00
@Charan-Sharan Charan-Sharan force-pushed the HPCC-31459-impl-master branch 2 times, most recently from 63914f7 to c5212a3 Compare July 22, 2024 11:19
AttilaVamos
AttilaVamos requested changes Jul 24, 2024
View reviewed changes
Copy link
Contributor

@AttilaVamos AttilaVamos left a comment

Choose a reason for hiding this comment

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

It is almost there, only a couple of questions, requests.

.github/workflows/Actions-workflow.yml Outdated Show resolved Hide resolved
.github/workflows/Actions-workflow.yml Outdated

markdownFile.write('\n\n```\n\n')

with open( markdown ,'a') as markdownFile:
Copy link
Contributor

Choose a reason for hiding this comment

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

Why are you reopen the markdown file? It is already opened in line 181.

.github/workflows/Actions-workflow.yml Show resolved Hide resolved
AttilaVamos
AttilaVamos approved these changes Jul 24, 2024
View reviewed changes
Copy link
Contributor

@AttilaVamos AttilaVamos left a comment

Choose a reason for hiding this comment

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

Seems good.

@Charan-Sharan Charan-Sharan force-pushed the HPCC-31459-impl-master branch from efd9646 to bc3041f Compare August 2, 2024 10:26
@Charan-Sharan Charan-Sharan marked this pull request as ready for review August 2, 2024 10:27
@Charan-Sharan Charan-Sharan force-pushed the HPCC-31459-impl-master branch from bc3041f to b2f0958 Compare August 2, 2024 10:30
Michael-Gardner
Michael-Gardner approved these changes Aug 2, 2024
View reviewed changes
Copy link
Contributor

@Michael-Gardner Michael-Gardner left a comment

Choose a reason for hiding this comment

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

Approving

.github/workflows/Actions-workflow.yml Outdated
markdownFile.write(f'\n {trigger} ---> {file}[\"{workflowDetails[file]["name"]}[{file}]\"]')
markdownFile.write('\n end\n')
markdownFile.write('\n```\n')
shell: python
Copy link
Contributor

Choose a reason for hiding this comment

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

Just for cleanliness, can we move this above the run: without breaking anything? Other than that, everything looks great.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, it is possible to move it above run:

@Charan-Sharan Charan-Sharan force-pushed the HPCC-31459-impl-master branch from b2f0958 to 2cf04a0 Compare August 2, 2024 16:23
@Charan-Sharan
Copy link
Contributor Author

@ghalliday could you please merge this PR?

@ghalliday ghalliday merged commit e5f8f61 into hpcc-systems:master Aug 8, 2024
48 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Michael-Gardner Michael-Gardner Michael-Gardner approved these changes

@AttilaVamos AttilaVamos AttilaVamos approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Charan-Sharan @AttilaVamos @Michael-Gardner @ghalliday