Merge pull request #1 from pseudomuto/master

Fetch HEAD

Author: maitreyaatish

.dockerignore

@@ -1,2 +1,6 @@
-/
-!/script
+.git/
+.github/
+dist/
+examples/
+fixtures/
+tmp/

.github/workflows/ci.yaml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        go: [ '1.17.2' ]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-go@v2
+        with:
+          go-version: ${{ matrix.go }}
+
+      - name: Dependencies
+        run: go get github.com/golang/protobuf/{proto,protoc-gen-go} github.com/haya14busa/goverage
+
+      - name: Tests
+        run: |
+          goverage -race -coverprofile=coverage.txt -covermode=atomic
+          make test/bench test/lint
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v2

.github/workflows/release.yaml

@@ -0,0 +1,31 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Login to Docker Hub
+        uses: docker/login-action@v1
+        with:
+          username: pseudomuto
+          password: ${{ secrets.DOCKER_TOKEN }}
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Setup Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.17
+      - name: Release
+        uses: goreleaser/goreleaser-action@v2
+        with:
+          version: latest
+          args: release --rm-dist
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_RELEASE_TOKEN }}

.gitignore

@@ -1,8 +1,4 @@
-/_tools
+/bin
 /coverage.txt
 /dist
-/gen_fixtures
-/protoc-gen-doc
-/test/*.dat
-/vendor
 /tmp/

.gofmtignore

@@ -0,0 +1,48 @@
+project_name: protoc-gen-doc
+
+before:
+  hooks:
+    - go mod tidy
+
+builds:
+  - main: ./cmd/protoc-gen-doc
+    env:
+      - CGO_ENABLED=0
+    goos:
+      - darwin
+      - linux
+      - windows
+    goarch:
+      - amd64
+      - arm64
+
+dockers:
+  - image_templates:
+      - pseudomuto/{{.ProjectName}}:latest
+      - pseudomuto/{{.ProjectName}}:{{.Version}}
+      - pseudomuto/{{.ProjectName}}:{{.Major}}
+      - pseudomuto/{{.ProjectName}}:{{.Major}}.{{.Minor}}
+    build_flag_templates:
+      - "--pull"
+      - "--label=org.opencontainers.image.created={{.Date}}"
+      - "--label=org.opencontainers.image.title={{.ProjectName}}"
+      - "--label=org.opencontainers.image.revision={{.FullCommit}}"
+      - "--label=org.opencontainers.image.version={{.Version}}"
+      - "--platform=linux/amd64"
+    extra_files:
+      - LICENSE.md
+      - README.md
+      - script/entrypoint.sh
+
+checksum:
+  name_template: 'checksums.txt'
+
+snapshot:
+  name_template: "{{ incpatch .Version }}-next"
+
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - '^docs:'
+      - '^test:'

.goreleaser.yaml

@@ -5,7 +5,36 @@ All noteworthy changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) (as of Feb 2018)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://github.com/pseudomuto/protoc-gen-doc/compare/v1.3.0...master)
+## [Unreleased](https://github.com/pseudomuto/protoc-gen-doc/compare/v1.5.0...master)
+
+_**CHANGELOG is now available with each release rather than in this file**_
+
+### Changed
+
+* Escape special characters in markdown anchors [#460](https://github.com/pseudomuto/protoc-gen-doc/pull/460)
+* Bump go to 1.17, protoc to 3.18.1, and leverage go:embed [#461](https://github.com/pseudomuto/protoc-gen-doc/pull/461)
+
+## [v1.5.0](https://github.com/pseudomuto/protoc-gen-doc/compare/v1.4.1...v1.5.0)
+
+* Add `source_relative` flag [#450](https://github.com/pseudomuto/protoc-gen-doc/pull/450)
+
+## [v1.4.1](https://github.com/pseudomuto/protoc-gen-doc/compare/v1.3.2...v1.4.1)
+
+* Add support for OneOf in templates [#436](https://github.com/pseudomuto/protoc-gen-doc/pull/436)
+* Note deprecated fields in HTML, Markdown, and Docbook outputs [#426](https://github.com/pseudomuto/protoc-gen-doc/pull/426)
+* Tidy up modules
+
+## [v1.3.2](https://github.com/pseudomuto/protoc-gen-doc/compare/v1.3.1...v1.3.2) - May 7, 2020
+
+### Changed
+
+* Stripped unnecessary whitespace from markdown templates [#410](https://github.com/pseudomuto/protoc-gen-doc/pull/410)
+* Renamed `lyft_validate` extension to `envoyproxy_validate`
+    [#392](https://github.com/pseudomuto/protoc-gen-doc/pull/392)
+* Fixed `envoyproxy_validate` rules with slice values such as `in` and `not_in`
+    [#392](https://github.com/pseudomuto/protoc-gen-doc/pull/392)
+
+## [v1.3.1](https://github.com/pseudomuto/protoc-gen-doc/compare/v1.3.0...v1.3.1) - March 3, 2020
 
 ### Changed
 

.travis.yml

@@ -7,10 +7,10 @@ First off, glad you're here and want to contribute! :heart:
 In order to work on this project, you'll need to install a few things:
 
 1. A recent version of [Go](https://golang.org/doc/install)
-1. [protoc](https://github.com/google/protobuf#protocol-compiler-installation) - The protobuf compiler
-1. [Docker](https://www.docker.com/) (only required to if you need/want to build the docker container via `make docker`)
+1. [Docker](https://www.docker.com/) (only required to use `make dev/docker`, `make test/docker`, or release targets).
+1. [unzip](http://infozip.sourceforge.net/)
 
-Once those are installed, running `make setup` should get you the rest of the way.
+Everything else that's needed will be installed as needed and put in `./bin`.
 
 When writing tests, be sure that the package in the test file is suffixed with `_test`. Eg. `protoc_gen_doc_test`. This
 ensures that you'll only be testing the public interface.
@@ -19,13 +19,14 @@ ensures that you'll only be testing the public interface.
 
 Here are some general guidelines for making PRs for this repo.
 
-1. [Fork this repo](https://github.com/pseudomuto/protoc-gen-doc/fork)
-1. Make a branch off of master (`git checkout -b <your_branch_name>`)
-1. Make focused commits with descriptive messages
-1. Add tests that fail without your code, and pass with it
-1. GoFmt your code! (see <https://blog.golang.org/go-fmt-your-code> to setup your editor to do this for you)
-1. Be sure to run `make examples` so your changes are reflected in the example docs
-1. **Ping someone on the PR** (Lots of people, including myself, won't get a notification unless pinged directly)
+1. [Fork this repo](https://github.com/pseudomuto/protoc-gen-doc/fork).
+1. Make a branch off of master (`git checkout -b <your_branch_name>`).
+1. Make focused commits with descriptive messages.
+1. Add tests that fail without your code, and pass with it.
+1. GoFmt your code! (see <https://blog.golang.org/go-fmt-your-code> to setup your editor to do this for you).
+1. Be sure to run `make build/examples` so your changes are reflected in the example docs.
+1. Running `make test/docker` should produce the same output as `make build/examples`.
+1. **Ping someone on the PR** (Lots of people, including myself, won't get a notification unless pinged directly).
 
 Every PR should have a well detailed summary of the changes being made and the reasoning behind them. Make sure to add
 at least three sections.
@@ -47,10 +48,10 @@ How has this change been tested? In your opinion what is the risk, if any, of me
 #### Reviewers should:
 
 1. Identify anything that the PR author may have missed from above.
-2. Test the PR through whatever means necessary, including manually, to verify it is safe to be deployed.
-3. Question everything. Never assume that something was tested or fully understood, always question and ask if there is
+1. Test the PR through whatever means necessary, including manually, to verify it is safe to be deployed.
+1. Question everything. Never assume that something was tested or fully understood, always question and ask if there is
 	 any uncertainty.
-4. Before merging the PR make sure it has _**one**_ of the `Major release`, `Minor release`, or `Patch release` labels
+1. Before merging the PR make sure it has _**one**_ of the `Major release`, `Minor release`, or `Patch release` labels
 	 applied to it (useful for the changelog and determining the version for the next release).
 
 ## Release Process
@@ -66,14 +67,12 @@ Look through the new (since the last release) PRs that are included in this rele
 
 ### Now that we've got the version:
 
-* Run `make docker_test` to build the image and generate the examples. There should be no diff after this.
-* Update the version in `version.go`
-* Update CHANGELOG.md. Be sure to include links to PRs and highlight new features, bug fixes, and any breaking changes.
-* Run `make release`
+From an up-to-date master, do the following:
 
-Now that the tag is on GitHub, we have a couple more things to do:
+1. Run `make test/docker` to build the image and generate the examples. There should be no diff after this.
+1. Update the version in `version.go` appropriately.
+1. `git commit -am "Bump to version v<version>`.
+1. `git tag -s v<version>`.
+1. `git push origin master --tags`.
 
-* Create a release based on the tag and copy the entry in CHANGELOG.md into the notes.
-* Run `make dist` and add the tar files (in `./dist`) to the release.
-
-Once CI has run for the tag, Travis will push the image to DockerHub.
+Once the tag is on GitHub, the release action will handle pushing to docker and creating a release in GitHub.

CHANGELOG.md

@@ -1,21 +1,13 @@
-FROM debian:jessie-slim
-LABEL maintainer="pseudomuto <[email protected]>" protoc_version="3.6.1"
-
+FROM alpine:3.15.0
 WORKDIR /
 
-ADD https://github.com/google/protobuf/releases/download/v3.6.1/protoc-3.6.1-linux-x86_64.zip ./
-RUN apt-get -q -y update && \
-  apt-get -q -y install unzip && \
-  unzip protoc-3.6.1-linux-x86_64.zip -d ./usr/local && \
-  rm protoc-3.6.1-linux-x86_64.zip && \
-  apt-get remove --purge -y unzip && \
-  apt-get autoremove && \
-  rm -rf /var/lib/apt/lists/*
+RUN apk --update add bash protoc protobuf-dev && rm -rf /var/cache/apk/*
 
-ADD dist/protoc-gen-doc /usr/local/bin/
-ADD script/entrypoint.sh ./
+COPY LICENSE.md README.md script/entrypoint.sh ./
+COPY protoc-gen-doc /usr/bin/
 
-VOLUME ["/out", "/protos"]
+VOLUME ["/out"]
+VOLUME ["/protos"]
 
-ENTRYPOINT ["/entrypoint.sh"]
+ENTRYPOINT ["./entrypoint.sh"]
 CMD ["--doc_opt=html,index.html"]