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

Automatic pull request for empty starter fails due to missing issue number in branch name #30601

Closed
3 tasks
dcolina opened this issue Nov 7, 2024 · 1 comment · Fixed by #30707
Closed
3 tasks

Comments

@dcolina
Copy link
Contributor

dcolina commented Nov 7, 2024

Parent Issue

No parent issue identified.

Problem Statement

The automatic pull request for the empty starter is failing because it does not comply with the branch naming rule, which requires an issue number to be included. Currently, the branch is created without the necessary issue number, causing the status check to fail. To resolve this, the issue number should be provided as an input to the action, allowing it to be dynamically included in the branch name and ensuring compliance with the naming convention.

Steps to Reproduce

  1. Trigger the automatic pull request process for the empty starter.
  2. Observe that the generated branch name does not include an issue number.
  3. Verify that the pull request fails the status check due to non-compliance with the branch naming rule.

Acceptance Criteria

  1. Modify the action to accept the issue number as an input parameter.
  2. Ensure the branch name for the pull request includes the issue number dynamically.
  3. Confirm that the updated naming convention passes the status check.

dotCMS Version

Not applicable.

Proposed Objective

Quality Assurance

Proposed Priority

Priority 2 - Important

External Links... Slack Conversations, Support Tickets, Figma Designs, etc.

No external links provided.

Assumptions & Initiation Needs

  1. Ensure the issue number is correctly passed as an input to the action.
  2. Validate that the branch naming rule is followed and that the status check passes with the updated naming convention.

Quality Assurance Notes & Workarounds

No workaround is currently available; the action must be updated to meet the naming requirements.

Sub-Tasks & Estimates

  • Update the action to accept the issue number as an input parameter.
  • Modify the branch naming format to include the issue number dynamically.
  • Test the pull request process to ensure the status check passes.
github-merge-queue bot pushed a commit that referenced this issue Nov 20, 2024
…sue number in branch name (#30601) (#30707)

### Proposed Changes

This pull request introduces a new input parameter to the
`cicd_manual_publish-starter.yml` GitHub Actions workflow. The new input
parameter, `issue-number`, is used to create the PR branch in case of
the empty starter creation. Additionally, it adds a Slack notification
step to the workflow.

### Changes

1. **New Input Parameter**:
   - Introduce a new input parameter `issue-number`.
- This parameter is used to create the PR branch in case of the `Empty
Starter` creation.

2. **Message Composition**:
   - Construct a detailed message about the newly published starter.
- Include information such as starter type, artifact filename, artifact
URL, old assets included, and changelog.
   - Append the composed message to the GitHub Actions output.

3. **Slack Notification Step**:
   - Add a new step named "Slack Notification" to the workflow.
- Use the custom GitHub Action located at
`.github/actions/core-cicd/notification/notify-slack`.
   - Send a notification to the `log-starter` Slack channel.
   - Use the composed message as the payload for the Slack notification.
   - Retrieve the Slack bot token from GitHub Secrets.

### Motivation

The addition of the `issue-number` input parameter ensures that the PR
branch is correctly created in case of the `Empty Starter` creation. The
Slack notification step ensures that team members are promptly informed
about new starter publications, improving communication and awareness
within the team, and meeting with the Status Check validation on PR
branch naming conventions.

### Testing

- Verified that the `issue-number` input parameter is correctly handled
and used to create the PR branch.
- Verified that the message is correctly composed and appended to the
GitHub Actions output.
- Confirmed that the Slack notification is sent to the specified channel
with the correct payload.

### Additional Info
This PR resolves #30601 (Automatic pull request for empty starter fails
due to missing issue number in branch name).
@github-project-automation github-project-automation bot moved this from In Review to Internal QA in dotCMS - Product Planning Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Internal QA
1 participant