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

GHA: Update names of workflow jobs #361

Merged
merged 7 commits into from
Nov 14, 2024

Conversation

peteski22
Copy link
Contributor

@peteski22 peteski22 commented Nov 13, 2024

What's changing

GitHub's UI can make it difficult to know for sure which task you're trying to associate with a required status check as it resolves only the job name and shows no information about the scope (i.e. the workflow name it is associate with).

This PR makes the job names more specific as to which workflow they are part of.

Once the PR merges it will be easier to find and configure the required status checks for PRs merging to main.

How to test it

Additional notes for reviewers

Current branch protection rules for main only have a few checks configured, but we'd want more to be successful before allowing a merge.

image

This way we can ensure that we don't accidentally merge with changes that wouldn't pass our linting for example.

I already...

  • added some tests for any new functionality
  • updated the documentation
  • checked if a (backend) DB migration step was required and included it if required

@peteski22 peteski22 added the gha GitHub actions related label Nov 13, 2024
Copy link
Contributor

@javiermtorres javiermtorres left a comment

Choose a reason for hiding this comment

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

Wdyt about the name suggestions?

.github/workflows/tests_uv.yaml Outdated Show resolved Hide resolved
.github/workflows/tests_uv_sdk.yaml Outdated Show resolved Hide resolved
.github/workflows/tests_uv.yaml Outdated Show resolved Hide resolved
.github/workflows/tests_uv.yaml Outdated Show resolved Hide resolved
@peteski22 peteski22 merged commit d9df710 into main Nov 14, 2024
7 checks passed
@peteski22 peteski22 deleted the github/update-workflow-names-for-ux branch November 14, 2024 09:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
gha GitHub actions related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants