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.

Sign up for GitHub

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

Jump to bottom

Remove noisy documentation preview comment #37387

Closed
wants to merge 2 commits into from
Closed

Remove noisy documentation preview comment #37387

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c69957
Remove noisy documentation preview comment
tobiasdiez Feb 18, 2024
7fdb169
Merge branch 'develop' into disable-pr-comment
tobiasdiez Mar 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 2 additions & 11 deletions .github/workflows/doc-publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,17 +63,8 @@ jobs:
NETLIFY_MESSAGE: ${{ steps.source-run-info.outputs.pullRequestNumber }}
NETLIFY_ALIAS: deploy-preview-${{ steps.source-run-info.outputs.pullRequestNumber }}

# Add deployment as status check, PR comment and annotation
# Add deployment as status check and annotation
# we could use the nwtgck/actions-netlify action for that, except for that it is not (yet) working in workflow_run context: https://github.com/nwtgck/actions-netlify/issues/545
- name: Add/Update deployment status PR comment
uses: marocchino/sticky-pull-request-comment@v2
with:
number: ${{ steps.source-run-info.outputs.pullRequestNumber }}
header: preview-comment
recreate: true
Copy link
Member

Choose a reason for hiding this comment

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

So, if we just drop this line. Then the noise is gone as well and we get a single comment that updates (silently) instead?

Copy link
Member

Choose a reason for hiding this comment

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

Would that be an acceptable approach to @kwankyu and @mkoeppe (and everybody else of course)?

Copy link
Contributor

Choose a reason for hiding this comment

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

No. Why do you ask the same question again? It has been clearly answered. The notification is what people who are doing the work want to get.

Copy link
Collaborator

Choose a reason for hiding this comment

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

@mkoeppe , actually no. The notification gets on my nerves. But more importantly, it may lead to me not noticing important messages, because I click "mark all as read"

Copy link
Member

Choose a reason for hiding this comment

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

Why do you ask the same question again?

I do by no means see this as a repeated question.

And I am trying to find some middle ground here between those who are annoyed by these notifications and those who want to keep them. With the proposed change, you still get all the relevant links. But if you want push notifications, you'd have to get these by other means.

The notification is what people who are doing the work want to get.

I hope you are not trying to imply anything with "people who are doing the work". There seems to be a substantial amount of people here who do not want these notifications.

So, unless I misunderstood you here. You want a notification and email every time the workflow finishes. So you want, what others consider spam. That's your opinion and you are entitled to it. But since that's precisely what others do not want, we have apparently no hope to come to a compromise here.

message: |
[Documentation preview for this PR](${{ steps.deploy-netlify.outputs.NETLIFY_URL }}/html/en) (built with commit ${{ steps.source-run-info.outputs.sourceHeadSha }}; [changes](${{ steps.deploy-netlify.outputs.NETLIFY_URL }}/CHANGES.html)) is ready! :tada:

- name: Update deployment status PR check
uses: myrotvorets/[email protected]
if: ${{ always() }}
Expand All @@ -90,7 +81,7 @@ jobs:

- name: Report deployment url
run: |
echo "::notice::The documentation has been deployed - ${{ steps.deploy-netlify.outputs.NETLIFY_URL }}"
echo "::notice::The documentation has been deployed - ${{ steps.deploy-netlify.outputs.NETLIFY_URL }}/html/en (built with commit ${{ steps.source-run-info.outputs.sourceHeadSha }}; changes: ${{ steps.deploy-netlify.outputs.NETLIFY_URL }}/CHANGES.html)"

publish-live-doc:
runs-on: ubuntu-latest
Expand Down
Loading