Skip to content

Commit 2d4d503

Browse files
authored
docs: migrate README.md to a website (#1094)
Make a website https://golangci-lint.run for golangci-lint documentation. The website is backed by Gatsby static site generator and deployed into Netlify.
1 parent a85e1e1 commit 2d4d503

35 files changed

+23001
-2150
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
11
Thank you for the pull request!
2-
3-
Please make sure you didn't directly change `README.md`: it should be changed only by changing `README.tmpl.md` and running `make README.md`.

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@
1313
/tools/svg-term
1414
/.vscode/
1515
*.test
16+
.DS_Store

CHANGELOG.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@ Follow the news and releases on our [twitter](https://twitter.com/golangci) and
22
There is the most valuable changes log:
33

44
### May 2020
5+
56
1. Add new linters: `nolintlint`, `goerr113`
6-
2. Updated linters: `godot`
7+
2. Updated linters: `godot`, `staticcheck`
78

89
### April 2020
910

1011
1. Add new linters: `testpackage`, `nestif`, `godot`, `gomodguard`, `asciicheck`
11-
2. Add github actions output format
12+
2. Add github actions output format
1213
3. Update linters: `wsl`, `gomodguard`, `gosec`
1314
4. Support `disabled-tags` setting for `gocritic`
1415
5. Mitigate OOM and "failed prerequisites"
@@ -63,4 +64,4 @@ There is the most valuable changes log:
6364
7. Support `--color` option
6465
8. Update x/tools to fix c++ issues
6566
9. Include support for log level
66-
10. Sort linters list in help commands
67+
10. Sort linters list in help commands

Makefile

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
.DEFAULT_GOAL = test
22
.PHONY: FORCE
33

4-
# enable module support across all go commands.
5-
export GO111MODULE = on
64
# enable consistent Go 1.12/1.13 GOPROXY behavior.
75
export GOPROXY = https://proxy.golang.org
86

@@ -42,14 +40,11 @@ test_linters:
4240

4341
# Maintenance
4442

45-
generate: README.md assets/demo.svg install.sh assets/github-action-config.json
43+
generate: install.sh assets/github-action-config.json
4644
.PHONY: generate
4745

48-
fast_generate: README.md
49-
.PHONY: fast_generate
50-
5146
maintainer-clean: clean
52-
rm -rf assets/demo.svg README.md install.sh
47+
rm -rf install.sh
5348
.PHONY: maintainer-clean
5449

5550
check_generated:
@@ -58,12 +53,6 @@ check_generated:
5853
git diff --exit-code # check no changes
5954
.PHONY: check_generated
6055

61-
fast_check_generated:
62-
$(MAKE) --always-make fast_generate
63-
git checkout -- go.mod go.sum # can differ between go1.12 and go1.13
64-
git diff --exit-code # check no changes
65-
.PHONY: fast_check_generated
66-
6756
release: .goreleaser.yml tools/goreleaser
6857
./tools/goreleaser
6958
.PHONY: release
@@ -85,22 +74,22 @@ tools/goreleaser: export GOFLAGS = -mod=readonly
8574
tools/goreleaser: tools/go.mod tools/go.sum
8675
cd tools && go build github.com/goreleaser/goreleaser
8776

77+
# TODO: migrate to docs/
8878
tools/svg-term: tools/package.json tools/package-lock.json
8979
cd tools && npm ci
9080
ln -sf node_modules/.bin/svg-term $@
9181

82+
# TODO: migrate to docs/
9283
tools/Dracula.itermcolors:
9384
curl -fL -o $@ https://raw.githubusercontent.com/dracula/iterm/master/Dracula.itermcolors
9485

86+
# TODO: migrate to docs/
9587
assets/demo.svg: tools/svg-term tools/Dracula.itermcolors
9688
./tools/svg-term --cast=183662 --out assets/demo.svg --window --width 110 --height 30 --from 2000 --to 20000 --profile ./tools/Dracula.itermcolors --term iterm2
9789

9890
install.sh: .goreleaser.yml tools/godownloader
9991
./tools/godownloader .goreleaser.yml | sed '/DO NOT EDIT/s/ on [0-9TZ:-]*//' > $@
10092

101-
README.md: FORCE golangci-lint
102-
go run ./scripts/gen_readme/main.go
103-
10493
assets/github-action-config.json: FORCE golangci-lint
10594
go run ./scripts/gen_github_action_config/main.go $@
10695

0 commit comments

Comments
 (0)