Git Product home page Git Product logo

docs-release-action's Introduction

docs-build-action GitHub Action

Inputs

  • revision (required) - The revision or version identifier for the documentation to be built.
  • project-name (required) - The documentation's project name, as specified in the configuration file's field with the corresponding name.
  • src-root (required) - The root directory where the source documentation files are located. The action will use this directory as the base location to look for the source files that need to be built.
  • storage-bucket (required) - The name of the storage bucket where the built documentation will be stored. After the documentation is successfully built, it will be uploaded to this specified bucket.
  • storage-endpoint (required) - The endpoint URL of the storage service.
  • storage-access-key-id (required) - The access key ID associated with the account that has permission to access and upload to the specified storage bucket.
  • storage-secret-access-key (required) - The secret access key associated with the account.
  • storage-region (required) - The region where the specified storage bucket is located.
  • lint-root (default: ./_docs-lint) - The root directory for the linting process. This is an optional parameter, and if not specified, the default value will be used.
  • build-root (default: ./_docs-build) - The root directory for the built documentation. This is an optional parameter, and if not specified, the default value will be used.
  • shared-storage-bucket (default: false) - Flag whether the bucket is shared across multiple projects.

Example

name: Release

on:
  workflow_dispatch:

jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Release
        uses: diplodoc-platform/docs-release-action@v1
        with:
          revision: "${{ github.sha }}"
          project-name: ${{ secrets.DOCS_PROJECT_NAME }}
          src-root: "./docs"
          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 }}

docs-release-action's People

Contributors

blinkov avatar yndx-birman avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.