Skip to content

Commit

Permalink
fix markdown linting
Browse files Browse the repository at this point in the history
  • Loading branch information
FG-TUM committed Jan 24, 2024
1 parent fdd9565 commit e8c0a84
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 10 deletions.
3 changes: 3 additions & 0 deletions .github/linters/.markdown-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MD004:
style: dash

# Disable line limits
MD013: false

# Ordered list item prefix
MD029:
style: one
27 changes: 17 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,19 +53,26 @@ This GitHub action was created from the [actions/typescrip-action template](http
The general development workflow should look as follows:

1. Create a new branch for your update
```bash
git checkout -b myAwsomeUpdate
```

```bash
git checkout -b myAwsomeUpdate
```

2. Implement your update in [`src/`](src) in TypeScript.

2.1 If you need new input values for the action, add them to [`action.yml`](action.yml)
3. Add tests to [`__tests__`](__tests__).
4. Format, build, and run the tests.
```bash
npm run all
```
This is critical. Without this step the JavaScript code, which is what's actually run, is not built and nothing changes!

```bash
npm run all
```

This is critical. Without this step the JavaScript code, which is what's actually run, is not built and nothing changes!
5. Commit, push, review, merge to main.
6. (If applicable) Create a new release using the [release script](script/release).
```bash
script/release
```

```bash
script/release
```

0 comments on commit e8c0a84

Please sign in to comment.