Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/traefik/mixtus
🤖 [Lasius Mixtus 🐜] Bot: Publish Documentation to a GitHub Repository from another
https://github.com/traefik/mixtus
documentation-tool github-bot
Last synced: 2 days ago
JSON representation
🤖 [Lasius Mixtus 🐜] Bot: Publish Documentation to a GitHub Repository from another
- Host: GitHub
- URL: https://github.com/traefik/mixtus
- Owner: traefik
- License: apache-2.0
- Created: 2020-08-05T13:52:25.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-04-04T09:20:06.000Z (over 1 year ago)
- Last Synced: 2024-08-17T08:07:15.236Z (3 months ago)
- Topics: documentation-tool, github-bot
- Language: Go
- Homepage:
- Size: 39.1 KB
- Stars: 1
- Watchers: 8
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Lasius Mixtus - Publish Documentation to a GitHub Repository From Another
[](https://github.com/traefik/mixtus/releases/latest)
[](https://github.com/traefik/mixtus/actions)
[](https://hub.docker.com/r/traefik/mixtus/builds/)
## Description
Lasius Mixtus is a cross-ci tool (GitHub Actions, SemaphoreCI 1 and 2, TravisCI, ...) used to aggregate documentation from different projects into one repository.
It is useful for building an aggregated documentation from different sources.
It creates PRs instead of commits to avoid conflicts and be able to validate the whole documentation before the merge.
```yml
Lasius Mixtus
Flags:
-debug
Debug mode
-dst-doc-path string
Path to put the documentation. (default "./traefik")
-dst-owner string
Owner of the targeted doc repo. (default "traefik")
-dst-repo-name string
Name of the targeted doc repo. (default "doc")
-git-user-email string
Email used to commit the documentation. [GIT_USER_EMAIL]
-git-user-name string
UserName used to commit the documentation. [GIT_USER_NAME]
-h Show this help.
-src-doc-path string
Path to the documentation. (default "./docs/site")
-src-owner string
Owner of the source repository. (default "traefik")
-src-repo-name string
Name of the source repo. (default "traefik")
-token string
GitHub Token [GITHUB_TOKEN]
```
## Workflow Example
This workflow also uses:
- [structor](https://github.com/traefik/structor): creates multiple versions of a Mkdocs documentation
- [seo-doc](https://github.com/traefik/seo-doc): enrich HTML files with pre-requisites for improving SEO
- [mixtus](https://github.com/traefik/mixtus): creates PRs with documentation changes
- [lobicornis](https://github.com/traefik/lobicornis): rebases and merges PRs automatically
The result is here: https://doc.traefik.io/
## Examples
```bash
GITHUB_TOKEN=xxx ./mixtus \
--src-owner=containous \
--src-repo-name=traefik \
--src-doc-path="./docs/site/" \
--dst-repo-name=doc \
--dst-doc-path="./traefik" \
--git-user-name=botname \
[email protected]
```
## The Mymirca colony
- [Myrmica Lobicornis](https://github.com/traefik/lobicornis) 🐜: Update and merge pull requests.
- [Myrmica Aloba](https://github.com/traefik/aloba) 🐜: Add labels and milestone on pull requests and issues.
- [Messor Structor](https://github.com/traefik/structor) 🐜: Manage multiple documentation versions with Mkdocs.
- [Lasius Mixtus](https://github.com/traefik/mixtus) 🐜: Publish documentation to a GitHub repository from another.
- [Myrmica Bibikoffi](https://github.com/traefik/bibikoffi) 🐜: Closes stale issues
- [Chalepoxenus Kutteri](https://github.com/traefik/kutteri) 🐜: Track a GitHub repository and publish on Slack.
- [Myrmica Gallienii](https://github.com/traefik/gallienii) 🐜: Keep Forks Synchronized
## What does Lasius Mixtus mean?
