Skip to content

Improve onboarding workflow messaging for pending and existing members #18

@Ubayed-Bin-Sufian

Description

@Ubayed-Bin-Sufian

Description

The current Org invite & team add — Codeheat GitHub Actions workflow correctly handles inviting users to the FOSSASIA organization and adding them to the codeheat team. However, there are a few UX and clarity issues in how onboarding results are communicated via issue comments.

Current Issues

  1. Pending invitations close the issue immediately

    • When a user is newly invited, the workflow posts a comment indicating pending org/team membership and then immediately closes the issue.
    • While this is technically correct (GitHub does not emit events for invitation acceptance), the messaging does not clearly explain that:
      • The workflow cannot wait for acceptance
      • The issue is closed because the request has been processed, not completed
  2. Existing members receive misleading messaging

    • If a user is already an active member of the org and team, the workflow still posts:

      “Onboarding processed”

    • This can be confusing, as no onboarding action actually occurred.
    • The message should explicitly state that the user is already a member and no further action is required.
  3. Workflow fails due to ORG_ADMIN_TOKEN validation (despite secret being present)

    • github.token inside actions/github-script does not always reflect the actual token string
    • The shell check confirms the secret exists, but the JavaScript validation incorrectly fails

Proposed Improvement

  • Differentiate between:
    • New invitations sent
    • Existing org/team members
  • Improve the final issue comment to:
    • Clearly instruct new users to accept the GitHub invitation
    • Clearly inform existing members that they are already onboarded
  • Keep the current behavior of closing the issue after processing, since GitHub Actions cannot react to invitation acceptance events.
  • Remove redundant / misleading token validation inside github-script

Expected Outcome

  • Clear, accurate onboarding comments
  • Reduced confusion for contributors
  • More maintainable and reviewer-friendly automation behavior
  • No false-negative failures due to token checks

This change focuses on improving communication and UX without altering the core workflow logic.

Metadata

Metadata

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions