From 4befbe8bf20e3e4ba605ecf300cade38089ffcc5 Mon Sep 17 00:00:00 2001 From: Ivan Fonseca Date: Sun, 15 Mar 2020 14:58:01 -0400 Subject: [PATCH] Add index to readme --- README.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 65591a4..f17929e 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,6 @@ A superpowered issue and pull request labeler for Github Actions. Super Labeler allows you to define your repository's labels in a config file that's checked into your repository. You can then define conditions that will be checked to apply and remove these labels on issues and pull requests. -- [Getting Started](#getting-started) -- [How it Works](#how-it-works) -- [Config File Format](#config-file-format) -- [Available Conditions](#available-conditions) - ## Getting Started Create a new Github Actions workflow at `.github/workflows/label.yml`: @@ -83,6 +78,21 @@ Now create the labeler config file at `.github/labels.json`: Be sure that Github Actions is enabled for in your repository's settings. Super Labeler will now run on your issues and pull requests. +## Index + +- [Getting Started](#getting-started) +- [Index](#index) +- [How it Works](#how-it-works) +- [Config File Format](#config-file-format) +- [Available Conditions](#available-conditions) + - [branchMatches](#branchmatches) + - [creatorMatches](#creatormatches) + - [descriptionMatches](#descriptionmatches) + - [isDraft](#isdraft) + - [isLocked](#islocked) + - [isOpen](#isopen) + - [titleMatches](#titlematches) + ## How it Works Whenever Super Labeler runs, it will first add and update your repository's labels to match your config. Then it will go through each label's conditions to determine if it should apply or remove that label.