https://github.com/shuttl-tech/drone-docmaker
Drone plugin to generate static website and push to S3
https://github.com/shuttl-tech/drone-docmaker
documentation drone-plugin mkdocs static-site static-website
Last synced: about 1 month ago
JSON representation
Drone plugin to generate static website and push to S3
- Host: GitHub
- URL: https://github.com/shuttl-tech/drone-docmaker
- Owner: Shuttl-Tech
- License: mpl-2.0
- Created: 2020-01-16T11:21:26.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-11-02T12:12:52.000Z (over 5 years ago)
- Last Synced: 2025-08-12T01:38:16.677Z (11 months ago)
- Topics: documentation, drone-plugin, mkdocs, static-site, static-website
- Language: Shell
- Size: 14.6 KB
- Stars: 0
- Watchers: 17
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Docmaker
Drone plugin to generate static website with [mkdocs][] and push it to S3.
### Usage
In your `.drone.yaml` file configure a pipeline step to use this plugin:
```yaml
kind: pipeline
name: default
steps:
- name: docs
image: shuttleng/drone-docmaker:latest
settings:
bucket: s3.bucket.name
site_path: docs/project
source_dir: docs
iam_role_arn: arn:aws:iam::1234567890:role/RoleWithS3PutObjectPermissions
aws_region: us-east-1
```
### Configuration
Following configuration options are available:
| Setting | Required | Description |
|:---------:|:---------:|--------|
| `bucket` | Yes | Name of the S3 bucket where the site will be uploaded |
| `site_path` | Yes | S3 file path prefix where the site will be uploaded. Do not add leading or trailing slashes |
| `source_dir` | No | Directory that contains the source files for site generation. Defaults to `docs` |
| `iam_role_arn` | No | ARN of the IAM role to assume. Used for S3 file sync |
| `aws_region` | No | AWS region name used by aws-cli commands |
| `site_generation` | No | `true` if you want to generate html files from markdown files, `false` if the source files are already html. Defaults to `true` |
Note that if you use an iam role to acquire credentials for S3, the drone agent EC2 role must have permission to assume the configured role.