Skip to content

Commit 3f36185

Browse files
authored
Move misspell to github actions (open-telemetry#1244)
* Move misspell to github actions Signed-off-by: Bogdan Drutu <[email protected]> * Delete circleci config Signed-off-by: Bogdan Drutu <[email protected]>
1 parent 143dfb8 commit 3f36185

File tree

8 files changed

+27
-36
lines changed

8 files changed

+27
-36
lines changed

.circleci/config.yml

-21
This file was deleted.

.github/workflows/markdown.yaml .github/workflows/checks.yaml

+14-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Markdown Check
1+
name: Checks
22

33
on:
44
push:
@@ -9,7 +9,6 @@ on:
99
jobs:
1010
markdownlint:
1111
runs-on: ubuntu-latest
12-
1312
steps:
1413
- name: check out code
1514
uses: actions/checkout@v2
@@ -19,9 +18,9 @@ jobs:
1918

2019
- name: run markdownlint
2120
run: make markdownlint
21+
2222
markdown-link-check:
2323
runs-on: ubuntu-latest
24-
2524
steps:
2625
- name: check out code
2726
uses: actions/checkout@v2
@@ -31,3 +30,15 @@ jobs:
3130

3231
- name: run markdown-link-check
3332
run: make markdown-link-check
33+
34+
misspell:
35+
runs-on: ubuntu-latest
36+
steps:
37+
- name: check out code
38+
uses: actions/checkout@v2
39+
40+
- name: install misspell
41+
run: sudo make install-misspell
42+
43+
- name: run misspell
44+
run: make misspell

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,4 @@ bin
2323
.swp
2424

2525
# Misspell binary
26-
.tools
26+
internal/tools/bin

Makefile

+6-5
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,24 @@
22
ALL_DOCS := $(shell find . -name '*.md' -not -path './.github/*' -type f | grep -v ^./node_modules | sort)
33
PWD := $(shell pwd)
44

5-
TOOLS_DIR := ./.tools
6-
MISSPELL_BINARY=$(TOOLS_DIR)/misspell
5+
TOOLS_DIR := ./internal/tools
6+
MISSPELL_BINARY=bin/misspell
7+
MISSPELL = $(TOOLS_DIR)/$(MISSPELL_BINARY)
78
MARKDOWN_LINK_CHECK=markdown-link-check
89
MARKDOWN_LINT=markdownlint
910

1011

1112
.PHONY: install-misspell
1213
install-misspell:
13-
go build -o $(MISSPELL_BINARY) github.com/client9/misspell/cmd/misspell
14+
cd $(TOOLS_DIR) && go build -o $(MISSPELL_BINARY) github.com/client9/misspell/cmd/misspell
1415

1516
.PHONY: misspell
1617
misspell:
17-
$(MISSPELL_BINARY) -error $(ALL_DOCS)
18+
$(MISSPELL) -error $(ALL_DOCS)
1819

1920
.PHONY: misspell-correction
2021
misspell-correction:
21-
$(MISSPELL_BINARY) -w $(ALL_DOCS)
22+
$(MISSPELL) -w $(ALL_DOCS)
2223

2324
.PHONY: install-markdown-link-check
2425
install-markdown-link-check:

go.mod

-5
This file was deleted.

internal/tools/go.mod

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
module github.com/open-telemetry/opentelemetry-specification/internal/tools
2+
3+
go 1.12
4+
5+
require github.com/client9/misspell v0.3.4

go.sum internal/tools/go.sum

File renamed without changes.

internal/tools.go internal/tools/tools.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
// +build tools
1717

18-
package internal
18+
package tools
1919

2020
// This file follows the recommendation at
2121
// https://github.com/golang/go/wiki/Modules#how-can-i-track-tool-dependencies-for-a-module

0 commit comments

Comments
 (0)