Skip to content

Commit 27050b1

Browse files
committed
Move contribution instructions to separate file
1 parent 90a83e7 commit 27050b1

File tree

2 files changed

+31
-32
lines changed

2 files changed

+31
-32
lines changed

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributing
2+
3+
## Testing problem matchers locally
4+
5+
Since GitHub Actions are functionally very similar to [VS Code's problem matchers]() (outside of some [exceptions](https://github.com/actions/runner/blob/master/docs/adrs/0276-problem-matchers.md#where-we-diverge-from-vscode)), we can use VS Code locally to quickly test the matcher patterns.
6+
7+
1. Make sure VS Code `.vscode/tasks.json` file is in sync with actual problem matchers
8+
```bash
9+
# Run helper script to setup VS Code tasks
10+
npm run setup-tasks
11+
```
12+
1. Run task in VS Code using the `Tasks: Run Task` command from the command palette
13+
14+
15+
## Release a new version
16+
17+
GitHub Actions will run the entry point from the action.yml. Packaging assembles the code into one file that can be checked in to Git, enabling fast and reliable execution and preventing the need to check in node_modules.
18+
19+
Actions are run from GitHub repos. Packaging the action will create a packaged action in the dist folder.
20+
21+
Run package
22+
23+
```bash
24+
npm run package
25+
```
26+
27+
Since the packaged index.js is run from the dist folder, make sure to commit its contents.
28+
29+
```bash
30+
git add dist
31+
```

README.md

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -30,35 +30,3 @@ uses: lumaxis/shellcheck-problem-matchers@v1
3030
with:
3131
format: gcc # Available options are "gcc" or "tty"
3232
```
33-
34-
## Contributing
35-
36-
### Testing problem matchers locally
37-
38-
Since GitHub Actions are functionally very similar to [VS Code's problem matchers]() (outside of some [exceptions](https://github.com/actions/runner/blob/master/docs/adrs/0276-problem-matchers.md#where-we-diverge-from-vscode)), we can use VS Code locally to quickly test the matcher patterns.
39-
40-
1. Make sure VS Code `.vscode/tasks.json` file is in sync with actual problem matchers
41-
```sh
42-
# Run helper script to setup VS Code tasks
43-
npm run setup-tasks
44-
```
45-
1. Run task in VS Code using the `Tasks: Run Task` command from the command palette
46-
47-
48-
### Release a new version
49-
50-
GitHub Actions will run the entry point from the action.yml. Packaging assembles the code into one file that can be checked in to Git, enabling fast and reliable execution and preventing the need to check in node_modules.
51-
52-
Actions are run from GitHub repos. Packaging the action will create a packaged action in the dist folder.
53-
54-
Run package
55-
56-
```bash
57-
npm run package
58-
```
59-
60-
Since the packaged index.js is run from the dist folder.
61-
62-
```bash
63-
git add dist
64-
```

0 commit comments

Comments
 (0)