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

chore(preview-envs): Look into improving commenting of preview enviro… #4060

Merged
merged 4 commits into from
Jul 25, 2024

Conversation

andromaqui
Copy link
Contributor

@andromaqui andromaqui commented Jul 24, 2024

…nments

Description

This pr aims to switch to a different action in order to post comments in prs called mshick/add-pr-comment. The newly
used action has the capability of always positioning the newly created comment in the latest comment position and requires very minimal configuration in order to find old comments.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

TEST

Test 1: Sequential deployments dont create a new group of messages

Tested with this commit by making a new push after there had already been a comment for the previous deployment

Test 2: Triggering the teardown workflow updates the preview-env-status comments

Tested with this commit by adding and removing the deploy label

@andromaqui andromaqui added the deploy Stand up a temporary docs site with this PR label Jul 24, 2024
@andromaqui andromaqui self-assigned this Jul 24, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs July 24, 2024 07:46 Destroyed
@camunda camunda deleted a comment from github-actions bot Jul 24, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs July 24, 2024 08:10 Destroyed
@camunda camunda deleted a comment from github-actions bot Jul 24, 2024
@camunda camunda deleted a comment from github-actions bot Jul 24, 2024
@camunda camunda deleted a comment from github-actions bot Jul 24, 2024
@camunda camunda deleted a comment from github-actions bot Jul 24, 2024
@camunda camunda deleted a comment from github-actions bot Jul 24, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs July 24, 2024 09:45 Destroyed
@camunda camunda deleted a comment from github-actions bot Jul 24, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs July 24, 2024 10:04 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs July 24, 2024 10:19 Destroyed
@andromaqui andromaqui added deploy Stand up a temporary docs site with this PR and removed deploy Stand up a temporary docs site with this PR labels Jul 24, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs July 24, 2024 10:47 Destroyed
@andromaqui andromaqui force-pushed the improve-commenting branch from 2f4e992 to d753783 Compare July 24, 2024 11:21
@camunda camunda deleted a comment from github-actions bot Jul 24, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs July 24, 2024 11:30 Destroyed
@andromaqui andromaqui removed the deploy Stand up a temporary docs site with this PR label Jul 24, 2024
@andromaqui andromaqui added the deploy Stand up a temporary docs site with this PR label Jul 24, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs July 24, 2024 12:25 Destroyed
@pepopowitz
Copy link
Collaborator

@andromaqui can you add some details to the body of this PR, to explain how you're looking to improve the comments?

@kellervater kellervater self-requested a review July 24, 2024 14:55
@kellervater
Copy link
Member

@andromaqui
Looking good to me.
Just 2 minor things you could change:

  • Remove message-id
  • remove: repo-token
    Both shouldn't be necessary to achieve your target.
    You can lookup this PR for reference on how I used it.

I marked all spots via PR commentary.

.github/workflows/preview-env-deploy.yml Outdated Show resolved Hide resolved
.github/workflows/preview-env-deploy.yml Outdated Show resolved Hide resolved
.github/workflows/preview-env-deploy.yml Outdated Show resolved Hide resolved
.github/workflows/preview-env-teardown.yml Outdated Show resolved Hide resolved
.github/workflows/preview-env-teardown.yml Outdated Show resolved Hide resolved
.github/workflows/preview-env-deploy.yml Outdated Show resolved Hide resolved
.github/workflows/preview-env-deploy.yml Outdated Show resolved Hide resolved
.github/workflows/preview-env-deploy.yml Outdated Show resolved Hide resolved
.github/workflows/preview-env-teardown.yml Outdated Show resolved Hide resolved
.github/workflows/preview-env-teardown.yml Outdated Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to camunda-docs July 24, 2024 18:31 Destroyed
@camunda camunda deleted a comment from github-actions bot Jul 24, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs July 24, 2024 19:13 Destroyed
@andromaqui andromaqui requested review from kellervater and removed request for kellervater July 25, 2024 07:17
@andromaqui andromaqui merged commit 39363bd into main Jul 25, 2024
9 checks passed
@andromaqui andromaqui deleted the improve-commenting branch July 25, 2024 07:48
Copy link
Contributor

🧹 Preview environment for this PR has been torn down.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deploy Stand up a temporary docs site with this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants