https://github.com/diplodoc-platform/docs-message-action

https://github.com/diplodoc-platform/docs-message-action

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/diplodoc-platform/docs-message-action
• Owner: diplodoc-platform
• Created: 2023-11-10T04:35:09.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-04-19T09:54:02.000Z (9 months ago)
• Last Synced: 2024-04-20T05:33:43.206Z (8 months ago)
• Size: 222 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# docs-message-action GitHub action

This GitHub action adds a comment to the pull request with the build log or preview link.

**Successful Build:**

![Success](./assets/success-message.png)

**Failed Build:**

![Failure](./assets/fail-message.png)

## Inputs

- `github-token` (required) - GitHub access token for authentication and authorization

- `project-link` (optional) - The link to the project documentation

## Usage

Create a file named `.github/workflows/post-build.yml` in your repo.

This workflow must run on completed [build workflow](https://github.com/diplodoc-platform/docs-build-action) and performs the following:

- Uploads build output to storage if the build log does not include errors.

- Adds a comment to the pull request with the build log or preview link.

```yaml

name: Upload & Message

on:

  workflow_run:

    workflows: [Build]

    types:

      - completed

jobs:

  post-build:

    permissions: write-all

    runs-on: ubuntu-latest

    steps:

      - name: Upload

        uses: diplodoc-platform/docs-upload-action@v1

        if: github.event.workflow_run.conclusion == 'success'

        with:

          github-token: ${{ secrets.GITHUB_TOKEN }}

          storage-endpoint: ${{ vars.DIPLODOC_STORAGE_ENDPOINT }}

          storage-region: ${{ vars.DIPLODOC_STORAGE_REGION }}

          storage-bucket: ${{ vars.DIPLODOC_STORAGE_BUCKET }}

          storage-access-key-id: ${{ secrets.DIPLODOC_ACCESS_KEY_ID }}

          storage-secret-access-key: ${{ secrets.DIPLODOC_SECRET_ACCESS_KEY }}

      - name: Comment message

        uses: diplodoc-platform/docs-message-action@v1

        with:

          github-token: ${{ secrets.GITHUB_TOKEN }}

          project-link: ${{ vars.DIPLODOC_PROJECT_LINK }}

```