Skip to content

Commit

Permalink
chore: refactor typedoc github action
Browse files Browse the repository at this point in the history
  • Loading branch information
brunotot committed Apr 17, 2024
1 parent b345ffe commit 4ddbeb4
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/workflows/typedoc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ on:
- "packages/**"
branches:
- main
workflow_dispatch:

jobs:
build:
Expand Down
26 changes: 26 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
- [1. Fork repository](#1-fork-repository)
- [1.1. Fork main branch](#11-fork-main-branch)
- [1.2. Enable workflows](#12-enable-workflows)
- [1.3. Configure workflow permissions](#13-configure-workflow-permissions)

## 1. Fork repository

### 1.1. Fork main branch

Fork main branch by clicking [here](https://github.com/brunotot/monorepo-mern-railway-starter/fork)

- you may customize the repository name and description
- make sure `Copy the main branch only` field is checked

### 1.2. Enable workflows

Go to your personal forked repository and open **Actions** tab.

- click on `I understand my workflows, go ahead and enable them`

### 1.3. Configure workflow permissions

On your personal forked repository, navigate to **Settings -> Actions -> General** and scroll to **Workflow permissions** panel.

- make sure that `Read and write permissions` and `Allow GitHub actions to create and approve pull requests` fields are checked
- save the new configuration.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
# monorepo-mern-railway-starter

-

# TOC

0 comments on commit 4ddbeb4

Please sign in to comment.