Skip to content

docs: migrate README.md to a website #1094

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 16, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
Thank you for the pull request!

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`.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@
/tools/svg-term
/.vscode/
*.test
.DS_Store
7 changes: 4 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,14 @@ Follow the news and releases on our [twitter](https://twitter.com/golangci) and
There is the most valuable changes log:

### May 2020

1. Add new linters: `nolintlint`, `goerr113`
2. Updated linters: `godot`
2. Updated linters: `godot`, `staticcheck`

### April 2020

1. Add new linters: `testpackage`, `nestif`, `godot`, `gomodguard`, `asciicheck`
2. Add github actions output format
2. Add github actions output format
3. Update linters: `wsl`, `gomodguard`, `gosec`
4. Support `disabled-tags` setting for `gocritic`
5. Mitigate OOM and "failed prerequisites"
Expand Down Expand Up @@ -63,4 +64,4 @@ There is the most valuable changes log:
7. Support `--color` option
8. Update x/tools to fix c++ issues
9. Include support for log level
10. Sort linters list in help commands
10. Sort linters list in help commands
21 changes: 5 additions & 16 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
.DEFAULT_GOAL = test
.PHONY: FORCE

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

Expand Down Expand Up @@ -42,14 +40,11 @@ test_linters:

# Maintenance

generate: README.md assets/demo.svg install.sh assets/github-action-config.json
generate: install.sh assets/github-action-config.json
.PHONY: generate

fast_generate: README.md
.PHONY: fast_generate

maintainer-clean: clean
rm -rf assets/demo.svg README.md install.sh
rm -rf install.sh
.PHONY: maintainer-clean

check_generated:
Expand All @@ -58,12 +53,6 @@ check_generated:
git diff --exit-code # check no changes
.PHONY: check_generated

fast_check_generated:
$(MAKE) --always-make fast_generate
git checkout -- go.mod go.sum # can differ between go1.12 and go1.13
git diff --exit-code # check no changes
.PHONY: fast_check_generated

release: .goreleaser.yml tools/goreleaser
./tools/goreleaser
.PHONY: release
Expand All @@ -85,22 +74,22 @@ tools/goreleaser: export GOFLAGS = -mod=readonly
tools/goreleaser: tools/go.mod tools/go.sum
cd tools && go build github.com/goreleaser/goreleaser

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

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

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

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

README.md: FORCE golangci-lint
go run ./scripts/gen_readme/main.go

assets/github-action-config.json: FORCE golangci-lint
go run ./scripts/gen_github_action_config/main.go $@

Expand Down
Loading