Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 9 additions & 22 deletions .github/workflows/table_of_contents.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Generate Table of contents section
name: Generate TOC section

on:
push:
Expand All @@ -11,24 +11,11 @@ jobs:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v1

- name: Generate table of content
id: generate
uses: LeChatErrant/table-of-contents-action@v1

- name: Commit
if: steps.generate.outputs.changes == 'true'
run: |
git config --local user.email "action@github.com"
git config --local user.name "GitHub Action"
git add README.md
git commit -m "doc: README.md table of contents updated [AUTO]"

- name: Push changes
if: steps.generate.outputs.changes == 'true'
uses: ad-m/github-push-action@master
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
branch: ${{ github.ref }}
- name: Generate table of content
id: generate
uses: technote-space/toc-generator@v4
with:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
FOLDING: true
COMMIT_NAME: GitHub Action
COMMIT_EMAIL: action@github.com
76 changes: 36 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,49 +62,45 @@ Lastly, it aims to save developers a lot of time since all nasty configurations
Table of Contents
=================

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
<details>
<summary>Details</summary>

<!--ts-->
* [API-template](#api-template)
* [Notes](#notes)
* [Table of Contents](#table-of-contents)
* [Architecture](#architecture)
* [Configuration](#configuration)
* [Development](#development)
* [Database](#database)
* [Production](#production)
* [Language](#language)
* [ORM](#orm)
* [Schema](#schema)
* [Generation](#generation)
* [Migrations](#migrations)
* [Linter](#linter)
* [Testing policy](#testing-policy)
* [Unit tests](#unit-tests)
* [Integration tests](#integration-tests)
* [TDD](#tdd)
* [Continuous integration](#continuous-integration)
* [Automated dependencies updates](#automated-dependencies-updates)
* [Logging](#logging)
* [Documentation](#documentation)
* [Postman](#postman)
* [Request validation](#request-validation)
* [Error handling](#error-handling)
* [RO](#ro)
* [Non-OK responses](#non-ok-responses)
* [Crashes](#crashes)
* [Async handler](#async-handler)
* [Route protection](#route-protection)
* [Authentification](#authentification)
* [Ownership](#ownership)
* [Me](#me)
* [Contributors](#contributors)
<!--te-->
<summary>Table of Contents</summary>

- [Architecture](#architecture)
- [Configuration](#configuration)
- [Development](#development)
- [Database](#database)
- [Production](#production)
- [Language](#language)
- [ORM](#orm)
- [Schema](#schema)
- [Generation](#generation)
- [Migrations](#migrations)
- [Linter](#linter)
- [Testing policy](#testing-policy)
- [Unit tests](#unit-tests)
- [Integration tests](#integration-tests)
- [TDD](#tdd)
- [Continuous integration](#continuous-integration)
- [Automated dependencies updates](#automated-dependencies-updates)
- [Logging](#logging)
- [Documentation](#documentation)
- [Postman](#postman)
- [Request validation](#request-validation)
- [Error handling](#error-handling)
- [RO](#ro)
- [Non-OK responses](#non-ok-responses)
- [Crashes](#crashes)
- [Async handler](#async-handler)
- [Route protection](#route-protection)
- [Authentification](#authentification)
- [Ownership](#ownership)
- [Me](#me)
- [Contributors](#contributors)

</details>

> Generated using [table-of-contents-action](https://github.com/LeChatErrant/table-of-contents-action), made by [LeChatErrant](https://github.com/LeChatErrant)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Architecture

Expand Down