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

Add reusable workflows structure, RW pre-commit, RW DangerJS, RW Sync Jira (3pack) #20

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

Conversation

tomassebestik
Copy link
Member

@tomassebestik tomassebestik commented Sep 2, 2024

Caution

Back in Draft - please hold off on your review.
Although this works, there might be a more elegant way by storing only "call-<reusable_workflow>" type actions here, and defining the reusable workflow in the repository of the action (e.g., https://github.com/espressif/sync-jira-actions).



This PR creates the structure for using GitHub reusable workflows that can be called from any repository within the Espressif GitHub organization.

Note

Their presence here does not mean they are automatically propagated or inherited across all Espressif organization GitHub repositories (as with issue and pull request templates).

These workflows need to be explicitly called.
See the .github/workflows/workflows-instructions.md (part of this PR) for more details.

Reasoning / Why This

Managing these workflows from a central place like this repository (espressif/.github) offers several advantages:

  • Ease of Integration: Simplifies the process for repository administrators—only a call statement is needed to integrate the workflow.
  • Centralized Updates: Quickly update the version of a GitHub workflow for all repositories that use it with a single change here.
  • Consistent Permissions: Ensure that action permissions are set correctly across all repositories.

Reusable Workflows in This PR

  • Configurable pre-commit reusable workflow
  • Configurable dangerjs reusable workflow
  • Configurable jira-sync reusable workflows (issues, pull requests, issue comments)
  • Instruction guide .github/workflows/workflows-instructions.md with example calls from target project

Tested

Tested in my test GitHub organization:

@tomassebestik tomassebestik self-assigned this Sep 2, 2024
@tomassebestik tomassebestik force-pushed the feat/organization-reusable-workflows branch from 2b994ed to 4dab103 Compare September 4, 2024 15:46
@tomassebestik tomassebestik marked this pull request as ready for review September 4, 2024 15:53
@tomassebestik tomassebestik changed the title Add reusable workflows structure, pre-commit and danger Add reusable workflows structure, RW pre-commit, RW DangerJS, RW Sync Jira (3pack) Sep 4, 2024
Copy link

@tom-borcin tom-borcin left a comment

Choose a reason for hiding this comment

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

LGTM!

@tomassebestik tomassebestik marked this pull request as draft September 5, 2024 05:44
@tomassebestik tomassebestik force-pushed the feat/organization-reusable-workflows branch from 4dab103 to ec43d8f Compare September 21, 2024 06:06
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.

2 participants