diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 0a6a074..2586bef 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -2,22 +2,17 @@ name: Build on: pull_request: + types: [opened, synchronize] jobs: build-docs: runs-on: ubuntu-latest + permissions: write-all steps: - name: Checkout uses: actions/checkout@v3 + - name: Build - uses: diplodoc-platform/docs-build-action@v1 + uses: diplodoc-platform/docs-build-action@v3 with: - revision: "pr-${{ github.event.pull_request.number }}" - project-name: ${{ secrets.DOCS_PROJECT_NAME }} - src-root: "./" - storage-bucket: ${{ secrets.DOCS_AWS_BUCKET }} - storage-endpoint: ${{ vars.DOCS_AWS_ENDPOINT }} - storage-access-key-id: ${{ secrets.DOCS_AWS_KEY_ID }} - storage-secret-access-key: ${{ secrets.DOCS_AWS_SECRET_ACCESS_KEY }} - storage-region: ${{ vars.DOCS_AWS_REGION }} - shared-storage-bucket: "true" + revision: "pr-${{ github.event.pull_request.number }}" \ No newline at end of file diff --git a/.github/workflows/post-build.yml b/.github/workflows/post-build.yml new file mode 100644 index 0000000..943e27c --- /dev/null +++ b/.github/workflows/post-build.yml @@ -0,0 +1,29 @@ +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.DOCS_AWS_ENDPOINT }} + storage-region: ${{ vars.DOCS_AWS_REGION }} + storage-bucket: ${{ vars.DIPLODOC_STORAGE_BUCKET }} + storage-access-key-id: ${{ secrets.DOCS_AWS_KEY_ID }} + storage-secret-access-key: ${{ secrets.DOCS_AWS_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 }} diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 1fbce8b..9221b9b 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -4,20 +4,39 @@ on: workflow_dispatch: jobs: - release: + build: runs-on: ubuntu-latest + permissions: write-all steps: - name: Checkout uses: actions/checkout@v3 - - name: Release - uses: diplodoc-platform/docs-release-action@v1 + - name: Build + uses: diplodoc-platform/docs-build-action@v3 with: revision: "${{ github.sha }}" - project-name: ${{ secrets.DOCS_PROJECT_NAME }} - src-root: "./" - storage-bucket: ${{ secrets.DOCS_AWS_BUCKET }} + upload: + needs: build + runs-on: ubuntu-latest + permissions: write-all + steps: + - name: Upload + uses: diplodoc-platform/docs-upload-action@v1 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + project-link: ${{ vars.DIPLODOC_PROJECT_LINK }} storage-endpoint: ${{ vars.DOCS_AWS_ENDPOINT }} + storage-region: ${{ vars.DOCS_AWS_REGION }} + storage-bucket: ${{ vars.DIPLODOC_STORAGE_BUCKET }} storage-access-key-id: ${{ secrets.DOCS_AWS_KEY_ID }} storage-secret-access-key: ${{ secrets.DOCS_AWS_SECRET_ACCESS_KEY }} - storage-region: ${{ vars.DOCS_AWS_REGION }} - shared-storage-bucket: "true" + release: + needs: upload + runs-on: ubuntu-latest + steps: + - name: Release + uses: diplodoc-platform/docs-release-action@v2 + with: + revision: "${{ github.sha }}" + storage-bucket: ${{ vars.DIPLODOC_STORAGE_BUCKET }} + storage-access-key-id: ${{ secrets.DOCS_AWS_KEY_ID }} + storage-secret-access-key: ${{ secrets.DOCS_AWS_SECRET_ACCESS_KEY }} \ No newline at end of file diff --git a/en/syntax/term.md b/en/syntax/term.md index b6b24d2..8766a8f 100644 --- a/en/syntax/term.md +++ b/en/syntax/term.md @@ -1,9 +1,3 @@ -[*term]: Explaining a term or abbreviation using definition syntax. -The _term_ definition may *include* [basic markup](base.md): -* lists; -* links; -* images, etc. - # Definition The syntax for definitions is: @@ -28,3 +22,9 @@ At the moment, the use of definitions in code blocks is possible only if the cod {% endnote %} ![terms_sample](../_images/terms_sample.png) + +[*term]: Explaining a term or abbreviation using definition syntax. +The _term_ definition may *include* [basic markup](base.md): +* lists; +* links; +* images, etc. \ No newline at end of file diff --git a/ru/syntax/term.md b/ru/syntax/term.md index 0169a0f..d707628 100644 --- a/ru/syntax/term.md +++ b/ru/syntax/term.md @@ -1,16 +1,10 @@ -[*term]: Разъяснение термина или сокращения с помощью синтаксиса определений. -Определение _термина_ может **включать** в себя [базовую разметку](base.md): -* списки; -* ссылки; -* картинки и т.д. - # Всплывающие подсказки Синтаксис для определений имеет вид: ``` [*ключ_термина]: Разъяснение термина или сокращения с помощью синтаксиса определений. -Определение термина может включать в себя _базовую_ разметку. +Определение термина может включать в себя _базовую_ разметку. Использование [термина](*ключ_термина) в тексте. ``` @@ -28,3 +22,9 @@ {% endnote %} ![terms_sample](../_images/terms_sample.png) + +[*term]: Разъяснение термина или сокращения с помощью синтаксиса определений. +Определение _термина_ может **включать** в себя [базовую разметку](base.md): +* списки; +* ссылки; +* картинки и т.д.