-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: rewrite repo docs and docs site (#577)
docs: docs and site rework Signed-off-by: Tomer Figenblat <[email protected]>
- Loading branch information
Showing
17 changed files
with
160 additions
and
259 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,83 +1,30 @@ | ||
| <h1 align="center"> | ||
| Auto-Me-Bot | ||
| </h1> | ||
| # 🤖 Auto-Me-Bot | ||
|
|
||
| <p align="center"> | ||
| Managing a repository can be cumbersome :construction_worker: and tiresome :tired_face:.<br/> | ||
| Let alone managing multiple repositories used by multiple contributors and bots :anguished:.<br/><br/> | ||
| <strong> | ||
| My name is <a href="https://github.com/apps/auto-me-bot">auto-me-bot 🤖</a> I'm here to take some of the repo management load off your shoulders! | ||
| </strong> | ||
| </p> | ||
| 🚧 Managing a repository can be cumbersome and tiresome.<br/> | ||
| 🤖 [auto-me-bot][app] is here to take some of the load off your shoulders! | ||
|
|
||
| <div align="center"> | ||
| <table align="center"> | ||
| <td align="left"><a href=https://github.com/apps/auto-me-bot target="_blank">Install App</a></td> | ||
| <td align="left"><a href="https://auto-me-bot.tomfi.info/" target="_blank">Read Docs</a></td> | ||
| <td align="left"><a href="https://github.com/TomerFi/auto-me-bot/blob/main/.github/auto-me-bot.yml" target="_blank">Example Config</a></td> | ||
| </table> | ||
| </div> | ||
| 📖 Check the docs: [https://auto-me-bot.tomfi.info][docs]<br/> | ||
| 🖱️ Install the app: [https://github.com/apps/auto-me-bot][app] | ||
|
|
||
| <a href="https://auto-me-bot.tomfi.info/"> | ||
| <img align="center" src="https://raw.githubusercontent.com/TomerFi/auto-me-bot/main/docs/img/all-handlers-success.png" alt="all-handlers-success"/> | ||
| </a> | ||
| > [!Tip] | ||
| > If you enforce conventional commit messages, use [version-bumper-action][vba] to automate your release process. | ||
| <details> | ||
| <summary><strong>Failed Checks</strong></summary> | ||
| <a href="https://auto-me-bot.tomfi.info/"> | ||
| <img align="center" src="https://raw.githubusercontent.com/TomerFi/auto-me-bot/main/docs/img/all-handlers-fail.png" alt="all-handlers-fail"/> | ||
| </a> | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary><strong>Configuration</strong></summary> | ||
| <p align="left"> | ||
| Place a file :memo: called <em>auto-me-bot.yml</em> in your <em>.github</em> folder :file_folder: in the repos you want me to help out with.<br/> | ||
| Check out the <a href="https://auto-me-bot.tomfi.info/">documentation</a> to see what else I can do :call_me_hand:. | ||
| --- | ||
|
|
||
| ```yaml | ||
| # .github/auto-me-bot.yml | ||
| # .github/auto-me-bot.yml - check the docs for a complete example | ||
| --- | ||
| pr: | ||
| lifecycleLabels: # this means you I'll label PRs based on the their lifecycle. | ||
| conventionalCommits: # this means I'll enforce conventional commit messages in PRs. | ||
| conventionalTitle: # this means I'll enforce conventional title for PRs. | ||
| signedCommits: # this means I'll make sure all commits in PRs are signed with the 'Signed-off-by' trailer. | ||
| tasksList: # this means I'll verify completion of tasks list in PRs. | ||
| autoApprove: # you can tell about users or bots you trust, and I'll automatically approve their PRs. | ||
| lifecycleLabels: # label PRs based on their lifecycle | ||
| conventionalCommits: # enforce conventional commit messages in PRs | ||
| conventionalTitle: # enforce conventional title for PRs | ||
| signedCommits: # enforce all commits in PRs are signed with the 'Signed-off-by' trailer | ||
| tasksList: # verify completion of tasks list in PRs | ||
| autoApprove: # automatically approve specific PRs | ||
| ``` | ||
| ![success] | ||
| > When using both the `lifecycleLabels` and `autoApprove`, it's advised to keep them separated and in order.<br/> | ||
| > Otherwise, the GitHub's approve event might not make its way to the lifecycle handler, and we might miss a label. | ||
|
|
||
| </p> | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary><strong>Future Plans</strong></summary> | ||
| <ul> | ||
| <li>Size based labeling for pull requests</li> | ||
| <li>Automate assignees and reviewers for pull requests</li> | ||
| <li>Various handlers for event types other than <em>pull_request</em, such as <em>push</em> and and <em>issue</em> event types</li> | ||
| <li>Repository management capabilities, such as labels creation and settings syncing</li> | ||
| </ul> | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary><strong>Alternatives</strong></summary> | ||
| <p>Other awesome applications the offer similar handlers as <a href="https://github.com/apps/auto-me-bot">auto-me-bot</a></p> | ||
| <ul> | ||
| <li><a href="https://github.com/apps/dco">DCO</a></li> | ||
| <li><a href="https://github.com/apps/semantic-pull-requests">Semantic Pull Request</a></li> | ||
| <li><a href="https://github.com/marketplace/task-list-completed">Task List Completed</a></li> | ||
| <li><a href="https://github.com/marketplace/trafico-pull-request-labeler">Trafico</a></li> | ||
| </ul> | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary><strong>Works well with</strong></summary> | ||
| <p> | ||
| If you keep your commits conventional,<br/> | ||
| you can use the <a href="https://github.com/TomerFi/version-bumper-action">version-bumper-action</a> for <em>GitHub</em>, to automate your releases. | ||
| </p> | ||
| </details> | ||
| [app]: https://github.com/apps/auto-me-bot | ||
| [docs]: https://auto-me-bot.tomfi.info | ||
| [vba]: https://github.com/TomerFi/version-bumper-action | ||
| [success]: https://raw.githubusercontent.com/TomerFi/auto-me-bot/main/docs/img/all-handlers-success.png |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| ```yaml title=".github/auto-me-bot.yml" | ||
| --- | ||
| pr: | ||
| lifecycleLabels: # (6) | ||
| ignoreDrafts: false # (7) | ||
| labels: # (8) | ||
| reviewRequired: "status: needs review" | ||
| changesRequested: "status: changes requested" | ||
| moreReviewsRequired: "status: needs more reviews" | ||
| reviewStarted: "status: review started" | ||
| approved: "status: approved" | ||
| merged: "status: merged" | ||
| conventionalCommits: # (1) | ||
| rules: # (2) | ||
| conventionalTitle: # (9) | ||
| rules: # (10) | ||
| signedCommits: # (3) | ||
| ignore: # (4) | ||
| users: [] | ||
| emails: [] | ||
| tasksList: # (5) | ||
| autoApprove: # (11) | ||
| allBots: false | ||
| users: ["dependabot"] | ||
| ``` | ||
| 1. enforce conventional commit messages in PRs | ||
| 2. optionally configure rules<br/>[see commitlint options](https://commitlint.js.org/#/reference-rules) | ||
| 3. enforce all commits in PRs are signed with the 'Signed-off-by' trailer | ||
| 4. optionally ignore specific users | ||
| 5. verify completion of tasks list in PRs | ||
| 6. label PRs based on their lifecycle | ||
| 7. optionally ignore drafts, defaults to false | ||
| 8. specify the lifecycle stages you want and their label text<br/>you'll need to create the labels yourself | ||
| 9. enforce conventional title for PRs | ||
| 10. optionally configure rules<br/>[see commitlint options](https://commitlint.js.org/#/reference-rules) | ||
| 11. automatically approve specific PRs | ||
| ???+ tip | ||
| Place a configuration file in your _.github_ repo for global configuration. | ||
| ???+ warning | ||
| Create the actual labels in your repository before using them. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| ## Auto approve | ||
|
|
||
| --8<-- "handlers/auto-approve.md" | ||
|
|
||
| ## Conventional commits | ||
|
|
||
| --8<-- "handlers/conventional-commits.md" | ||
|
|
||
| ## Conventional title | ||
|
|
||
| --8<-- "handlers/conventional-title.md" | ||
|
|
||
| ## Lifecycle labels | ||
|
|
||
| --8<-- "handlers/lifecycle-labels.md" | ||
|
|
||
| ## Signed commits | ||
|
|
||
| --8<-- "handlers/signed-commits.md" | ||
|
|
||
| ## Tasks list | ||
|
|
||
| --8<-- "handlers/tasks-list.md" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,5 @@ | ||
| <figure markdown> | ||
| { width="800" } | ||
| <figcaption>auto approved pr - approved</figcaption> | ||
| </figure> | ||
| === "Approved" | ||
| { width="800" } | ||
|
|
||
| <figure markdown> | ||
| { width="800" } | ||
| <figcaption>auto approved pr - not approved</figcaption> | ||
| </figure> | ||
| === "None required" | ||
| { width="800" } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,5 @@ | ||
| <figure markdown> | ||
| { width="800" } | ||
| <figcaption>conventional commits successful</figcaption> | ||
| </figure> | ||
| === "Successful" | ||
| { width="800" } | ||
|
|
||
| <figure markdown> | ||
| { width="800" } | ||
| <figcaption>conventional commits failed</figcaption> | ||
| </figure> | ||
| === "Failed" | ||
| { width="800" } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,2 @@ | ||
| <figure markdown> | ||
| { width="800" } | ||
| <figcaption>conventional title enforcement</figcaption> | ||
| </figure> | ||
| === "Full" | ||
| { width="800" } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,20 @@ | ||
| <figure markdown> | ||
| { width="800" } | ||
| <figcaption>lifecycle labels - review required</figcaption> | ||
| </figure> | ||
| === "Review required" | ||
| { width="800" } | ||
|
|
||
| <figure markdown> | ||
| { width="800" } | ||
| <figcaption>lifecycle labels - review required</figcaption> | ||
| </figure> | ||
| === "Review started" | ||
| { width="800" } | ||
|
|
||
| <figure markdown> | ||
| { width="800" } | ||
| <figcaption>lifecycle labels - changes requested</figcaption> | ||
| </figure> | ||
| === "Changed requested" | ||
| { width="800" } | ||
|
|
||
| <figure markdown> | ||
| { width="800" } | ||
| <figcaption>lifecycle labels - more reviews required</figcaption> | ||
| </figure> | ||
| === "More reviews required" | ||
| { width="800" } | ||
|
|
||
| <figure markdown> | ||
| { width="800" } | ||
| <figcaption>lifecycle labels - approved</figcaption> | ||
| </figure> | ||
| === "Approved" | ||
| { width="800" } | ||
|
|
||
| <figure markdown> | ||
| { width="800" } | ||
| <figcaption>lifecycle labels - merged</figcaption> | ||
| </figure> | ||
| === "Merged" | ||
| { width="800" } | ||
|
|
||
| <figure markdown> | ||
| { width="800" } | ||
| <figcaption>lifecycle labels - check report</figcaption> | ||
| </figure> | ||
| === "Check status" | ||
| { width="800" } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,5 @@ | ||
| <figure markdown> | ||
| { width="800" } | ||
| <figcaption>signed commits successful</figcaption> | ||
| </figure> | ||
| === "Successful" | ||
| { width="800" } | ||
|
|
||
| <figure markdown> | ||
| { width="800" } | ||
| <figcaption>signed commits failed</figcaption> | ||
| </figure> | ||
| === "Failed" | ||
| { width="800" } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,8 @@ | ||
| <figure markdown> | ||
| { width="800" } | ||
| <figcaption>tasks list successful</figcaption> | ||
| </figure> | ||
| === "Successful" | ||
| { width="800" } | ||
|
|
||
| <figure markdown> | ||
| { width="800" } | ||
| <figcaption>tasks lists failed</figcaption> | ||
| </figure> | ||
| === "Failed" | ||
| { width="800" } | ||
|
|
||
| <figure markdown> | ||
| { width="800" } | ||
| <figcaption>tasks lists non-found</figcaption> | ||
| </figure> | ||
| === "Not found" | ||
| { width="800" } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,19 @@ | ||
| Managing a repository can be cumbersome :construction_worker: and tiresome :tired_face:.</br> | ||
| Let alone managing multiple repositories used by multiple contributors and bots :anguished:.</br> | ||
| 🚧 Managing a repository can be cumbersome and tiresome.<br/> | ||
| 🤖 **auto-me-bot** is here to take some of the load off your shoulders! | ||
|
|
||
| My name is **auto-me-bot** :robot:!</br> | ||
| I'm here to take some of the load off your shoulders, just tell me what you want me to do...</br> | ||
| ## Install | ||
|
|
||
| ## Installation | ||
| --8<-- "install.md" | ||
|
|
||
| --8<-- "docs/installation.md" | ||
| ## Config | ||
|
|
||
| ## Configuration | ||
| --8<-- "config.md" | ||
|
|
||
| --8<-- "docs/configuration.md" | ||
| === "Successful" | ||
| { width="800" } | ||
|
|
||
| ## Look-See | ||
| === "Failed" | ||
| { width="800" } | ||
|
|
||
| --8<-- "docs/look-see.md" | ||
|
|
||
| ## Spec | ||
|
|
||
| --8<-- "docs/spec.md" | ||
|
|
||
| ## License | ||
|
|
||
| --8<-- "docs/license.md" | ||
| ???+ info | ||
| Click [here](examples.md) for more examples. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.