fevrin / home Goto Github PK

Background

Per the title, we need to add a CODEOWNERS file in the root of the repository (which is compatible with both GitHub and GitLab).

Definition of Done

• CODEOWNERS file exists in the root of the repo and properly pings the code owners when files are changed

Background

Commitlint may not be fully working at the moment; confirm it's actually reviewing commit messages and stopping bad ones from being used.

Definition of Done

• commitlint is for sure working as expected

Background

We need to set up CI to check the repo's settings to confirm they're as expected or warn the user to change them. With gh installed, the following info can be used to determine the repository's settings:

• General repo settings
• Branch rules
• GitHub Actions perms
• Allowed GitHub Actions
• Branch protection

Some settings to check:

• Automatically delete head branches
• Always suggest updating pull request branches
• Require status checks to pass before merging
• Require branches to be up to date before merging
• Allow repository, and select non-repository, actions and reusable workflows
• Allow GitHub Actions to create and approve pull requests
• workflow permissions

Definition of Done

• GitHub Action set up to check for certain repository settings

Background

The table of contents generator does a decent job until it handles a Markdown file with duplicate titles. In that case, the titles' links all point to the same reference, whereas the links for first duplicate title on should have -1, -2, etc. appended to it to properly reference the correct title.

For instance, right now a Markdown file like this:

# Main title

${TOC}

## Subtitle

## Subtitle 2

### Subtitle

### Subtitle 2

#### Subtitle 3

#### Subtitle 2

would get a table of contents like this:

- [Subtitle](#subtitle)
- [Subtitle 2](#subtitle-2)
  - [Subtitle](#subtitle)
  - [Subtitle 2](#subtitle-2)
    - [Subtitle 3](#subtitle-3)
    - [Subtitle 2](#subtitle-2)

instead of this:

- [Subtitle](#subtitle)
- [Subtitle 2](#subtitle-2)
  - [Subtitle](#subtitle-1)
  - [Subtitle 2](#subtitle-2-1)
    - [Subtitle 3](#subtitle-3)
    - [Subtitle 2](#subtitle-2-2)

Definition of Done

• table of contents generator correctly creates links for duplicate titles