Skip to content

Commit 91be339

Browse files
author
Release Manager
committed
gh-35563: Make doc preview message from github bot one liner <!-- Please provide a concise, informative and self-explanatory title. --> <!-- Don't put issue numbers in the title. Put it in the Description below. --> <!-- For example, instead of "Fixes #12345", use "Add a new method to multiply two integers" --> ### 📚 Description For each PR, github bot emits a comment with documentation preview message. Now it consists of two lines. This PR makes it one line, for quick eye scan from left to right once instead of twice. ![Screen Shot 2023-04-25 at 2 41 40 PM](https://user-images.githubuserco ntent.com/1456101/234184364-2e174edc-b895-470b-a675-cedbe1d263e8.png) (I also tried to make the doc link open in a new tab, but it seems close to impossible.) <!-- Describe your changes here in detail. --> <!-- Why is this change required? What problem does it solve? --> <!-- If this PR resolves an open issue, please link to it here. For example "Fixes #12345". --> <!-- If your change requires a documentation PR, please link it appropriately. --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. It should be `[x]` not `[x ]`. --> - [x] The title is concise, informative, and self-explanatory. - [x] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - #12345: short description why this is a dependency - #34567: ... --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: #35563 Reported by: Kwankyu Lee Reviewer(s): Matthias Köppe
2 parents 8a49d3b + d90d147 commit 91be339

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

.github/workflows/doc-publish.yml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Triggers after the documentation build has finished,
1+
# Triggers after the documentation build has finished,
22
# taking the artifact and uploading it to netlify
33
name: Publish documentation
44

@@ -47,7 +47,7 @@ jobs:
4747
});
4848
var fs = require('fs');
4949
fs.writeFileSync('${{github.workspace}}/docs.zip', Buffer.from(download.data));
50-
50+
5151
- name: Extract docs
5252
run: unzip docs.zip -d docs && unzip docs/docs.zip -d docs/docs
5353

@@ -72,9 +72,8 @@ jobs:
7272
header: preview-comment
7373
recreate: true
7474
message: |
75-
[Documentation preview for this PR](${{ steps.deploy-netlify.outputs.NETLIFY_URL }}) is ready! :tada:
76-
Built with commit: ${{ steps.source-run-info.outputs.sourceHeadSha }}
77-
75+
[Documentation preview for this PR](${{ steps.deploy-netlify.outputs.NETLIFY_URL }}) (built with commit ${{ steps.source-run-info.outputs.sourceHeadSha }}) is ready! :tada:
76+
7877
- name: Update deployment status PR check
7978
uses: myrotvorets/[email protected]
8079
if: ${{ always() }}

0 commit comments

Comments
 (0)