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

ci: Add Pre-release action to synchronize branches #804

Conversation

alexs-mparticle
Copy link
Collaborator

@alexs-mparticle alexs-mparticle commented Nov 20, 2023

Instructions

  1. PR target branch should be against development
  2. PR title name should follow this format: https://github.com/mParticle/mparticle-workflows/blob/main/.github/workflows/pr-title-check.yml
  3. PR branch prefix should follow this format: https://github.com/mParticle/mparticle-workflows/blob/main/.github/workflows/pr-branch-check-name.yml

Summary

  • This action synchronizes a release version of the web sdk between all necessary branches

Testing Plan

  • Was this tested locally? If not, explain why.
  • N/A This is a CI/CD Update

Reference Issue (For mParticle employees only. Ignore if you are an outside contributor)

@alexs-mparticle alexs-mparticle marked this pull request as ready for review November 20, 2023 20:27
.github/workflows/synchronize-branches.yml Outdated Show resolved Hide resolved
.github/workflows/synchronize-branches.yml Outdated Show resolved Hide resolved
.github/workflows/synchronize-branches.yml Outdated Show resolved Hide resolved
.github/workflows/synchronize-branches.yml Outdated Show resolved Hide resolved
.github/workflows/synchronize-branches.yml Outdated Show resolved Hide resolved
Copy link
Member

@rmi22186 rmi22186 left a comment

Choose a reason for hiding this comment

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

Mostly nits, but looks great overall.

.github/workflows/synchronize-branches.yml Outdated Show resolved Hide resolved
Comment on lines 6 to 10
dryRun:
description: 'Do a dry run to preview instead of a real release [true/false]'
required: true
type: boolean
default: true
Copy link
Member

Choose a reason for hiding this comment

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

nitpick - The term dryRun and the description isn't accurate here. Nothing is happening in the dryRun == true path, which I get is intentional - I'm being nitpicky about the variable name itself (and description). I'm not sure I have a better input here besides asking "Are you sure?" in this case.

Suggested change
dryRun:
description: 'Do a dry run to preview instead of a real release [true/false]'
required: true
type: boolean
default: true
dryRun:
description: 'Type in false to push a specific version of the mParticle Web SDK to all branches'
required: true
type: boolean
default: true

Comment on lines 21 to 22
# As a safe guard, if a valid release branch does not exist,
# this step will fail and throw an error
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
# As a safe guard, if a valid release branch does not exist,
# this step will fail and throw an error
# As a safe guard, if a valid release branch does not exist,
# this step will fail and throw an error.
# Pushing previous versions of the SDK will require manual intervention. This action is not used for rollbacks.

.github/workflows/synchronize-branches.yml Outdated Show resolved Hide resolved
@rmi22186
Copy link
Member

The commit name should also probably not be Pre-release, as it is the actual CDN release step.

Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@alexs-mparticle alexs-mparticle merged commit 69830ca into ci/SQDSDKS-5706-add-pre-release-action Nov 21, 2023
24 of 26 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.

2 participants