Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
ef55ddc
Remove deprecated ioutil (#73)
lucacome Apr 30, 2024
1a29344
Switch to GitHub Actions (#72)
lucacome Apr 30, 2024
91414af
Bump Go to 1.21 (#70)
lucacome Apr 30, 2024
4a797a9
Add dependabot (#71)
lucacome Apr 30, 2024
89e5ed0
Fix typo in workflow (#74)
lucacome Apr 30, 2024
5020c8c
Add GitHub Actions to depedndabot (#75)
lucacome Apr 30, 2024
5e94050
Bump goreleaser/goreleaser-action from 5.0.0 to 5.1.0 (#79)
dependabot[bot] May 14, 2024
04ee257
Bump goreleaser/goreleaser-action from 5.1.0 to 6.0.0 (#82)
dependabot[bot] Jun 10, 2024
9b789fe
Bump actions/setup-go from 5.0.0 to 5.0.1 (#77)
dependabot[bot] Jun 10, 2024
f3a5c77
Bump anchore/sbom-action from 0.15.11 to 0.16.0 (#80)
dependabot[bot] Jun 10, 2024
ed46227
Bump actions/checkout from 4.1.4 to 4.1.6 (#81)
dependabot[bot] Jun 10, 2024
a78f091
Bump k8s.io/klog/v2 from 2.120.1 to 2.130.0 (#83)
dependabot[bot] Jun 17, 2024
4b21651
Update README.md (#86)
lucacome Jul 9, 2024
2b5b05f
Bump GoReleaser config to v2 (#87)
lucacome Jul 11, 2024
fb5ea33
Switch to k8s.io/gengo/v2 (#90)
lucacome Jul 27, 2024
91fdeba
Bump anchore/sbom-action from 0.16.0 to 0.17.0 (#88)
dependabot[bot] Jul 27, 2024
0b5266a
Bump actions/setup-go from 5.0.1 to 5.0.2 (#89)
dependabot[bot] Jul 27, 2024
58b7536
Bump actions/checkout from 4.1.6 to 4.1.7 (#84)
dependabot[bot] Jul 27, 2024
819de22
Add version flag (#76)
lucacome Jul 27, 2024
642c3aa
Bump anchore/sbom-action from 0.17.0 to 0.17.1 (#92)
dependabot[bot] Aug 19, 2024
3c18040
Bump anchore/sbom-action from 0.17.1 to 0.17.2 (#93)
dependabot[bot] Aug 27, 2024
8575eb1
Bump sigstore/cosign-installer from 3.5.0 to 3.6.0 (#91)
dependabot[bot] Aug 27, 2024
6f15f48
Bump sigstore/cosign-installer from 3.6.0 to 3.7.0 (#96)
dependabot[bot] Oct 7, 2024
a253e3b
Bump actions/checkout from 4.1.7 to 4.2.1 (#95)
dependabot[bot] Oct 7, 2024
ffc4efd
Bump anchore/sbom-action from 0.17.2 to 0.17.3 (#97)
dependabot[bot] Oct 14, 2024
89e979a
Update Ubuntu runner to 24.04 (#99)
lucacome Oct 26, 2024
d381d6e
Fix display of maps (#66)
theunrepentantgeek Oct 28, 2024
8c2a0de
Bump actions/setup-go from 5.0.2 to 5.1.0 (#100)
dependabot[bot] Oct 28, 2024
939ccac
Bump actions/checkout from 4.2.1 to 4.2.2 (#102)
dependabot[bot] Oct 28, 2024
4e93af4
Bump anchore/sbom-action from 0.17.3 to 0.17.5 (#101)
dependabot[bot] Oct 28, 2024
71fefee
Bump anchore/sbom-action from 0.17.5 to 0.17.7 (#105)
dependabot[bot] Nov 11, 2024
b86131b
Bump sigstore/cosign-installer from 3.7.0 to 3.8.0 (#112)
dependabot[bot] Feb 10, 2025
02d1731
Bump anchore/sbom-action from 0.17.7 to 0.18.0 (#111)
dependabot[bot] Feb 10, 2025
a4e4190
Bump actions/setup-go from 5.1.0 to 5.3.0 (#110)
dependabot[bot] Feb 10, 2025
b98e7d5
Bump actions/setup-go from 5.3.0 to 5.4.0 (#115)
dependabot[bot] Mar 25, 2025
d91c2fc
Bump anchore/sbom-action from 0.18.0 to 0.19.0 (#117)
dependabot[bot] May 11, 2025
d24950c
Bump sigstore/cosign-installer from 3.8.0 to 3.8.2 (#118)
dependabot[bot] May 11, 2025
b72afbb
Bump goreleaser/goreleaser-action from 6.0.0 to 6.3.0 (#116)
dependabot[bot] May 11, 2025
f866bd5
Bump actions/setup-go from 5.4.0 to 5.5.0 (#119)
dependabot[bot] May 12, 2025
c2e9cae
Bump anchore/sbom-action from 0.19.0 to 0.20.0 (#121)
dependabot[bot] May 20, 2025
3d2cdab
fix unsupported type (#109)
dongjiang1989 Oct 29, 2025
b591789
Bump actions/checkout from 4.2.2 to 5.0.0 (#128)
dependabot[bot] Oct 29, 2025
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
11 changes: 11 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
version: 2
updates:
- package-ecosystem: gomod
directory: /
schedule:
interval: weekly

- package-ecosystem: github-actions
directory: /
schedule:
interval: weekly
52 changes: 52 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: CI

on:
push:
branches:
- master
tags:
- "v[0-9]+.[0-9]+.[0-9]+*"
pull_request:
branches:
- master

permissions:
contents: read

jobs:
build:
name: Build
runs-on: ubuntu-24.04
permissions:
contents: write
id-token: write
steps:
- name: Checkout Repository
uses: actions/[email protected]
with:
fetch-depth: 0

- name: Setup Golang Environment
uses: actions/[email protected]
with:
go-version: stable

- name: Download Syft
uses: anchore/sbom-action/[email protected]
if: github.ref_type == 'tag'

- name: Install Cosign
uses: sigstore/[email protected]
if: github.ref_type == 'tag'

- name: Build binary
uses: goreleaser/[email protected]
with:
version: latest
args: ${{ github.ref_type == 'tag' && 'release' || 'build --snapshot' }} --clean
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Print version
run: ./dist/gen-crd-api-reference-docs_linux_amd64_v1/gen-crd-api-reference-docs -version
continue-on-error: true
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,5 @@ refdocs

# goreleaser output
dist

gen-crd-api-reference-docs
44 changes: 30 additions & 14 deletions .goreleaser.yml
Original file line number Diff line number Diff line change
@@ -1,24 +1,40 @@
version: 2
builds:
- env:
- CGO_ENABLED=0
# travis ci currently sets GOPATH even with go1.11.
# force-setting GO111MODULE=on to use vgo
- GO111MODULE=on
goos:
- linux
- darwin
goarch:
- amd64
archive:
name_template: "{{ .ProjectName }}_{{ .Os }}_{{ .Arch }}"
files:
- LICENSE
- template/**
- example-config.json
- arm64
flags:
- -trimpath
ldflags:
- -s -w -X main.version={{.Version}}

archives:
- files:
- LICENSE
- template/**
- example-config.json

checksum:
name_template: "checksums.txt"
changelog:
skip: true
release:
# releases are uploaded to github by .travis.yml
disable: true

sboms:
- artifacts: archive
documents:
- "${artifact}.spdx.json"

signs:
- cmd: cosign
artifacts: checksum
output: true
certificate: "${artifact}.pem"
args:
- sign-blob
- "--output-signature=${signature}"
- "--output-certificate=${certificate}"
- "${artifact}"
- "--yes"
32 changes: 0 additions & 32 deletions .travis.yml

This file was deleted.

1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ CRD API Reference via https://doc.crds.dev/ without much effort.
- [**Antrea** API reference docs](https://antrea.io/docs/v1.3.0/docs/api-reference/)
- [**kube-green** API reference docs](https://kube-green.dev/docs/apireference_v1alpha1/)
- [**Azure Service Operator** supported resources](https://azure.github.io/azure-service-operator/reference/)
- [**NGINX Gateway Fabric** API reference docs](https://docs.nginx.com/nginx-gateway-fabric/reference/api/)
- _[[ADD YOUR PROJECT HERE]]_

Also some **forks**:
Expand Down
13 changes: 9 additions & 4 deletions go.mod
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
module github.com/ahmetb/gen-crd-api-reference-docs

go 1.15
go 1.21.0

require (
github.com/go-logr/logr v1.2.4 // indirect
github.com/russross/blackfriday/v2 v2.1.0
k8s.io/gengo v0.0.0-20230306165830-ab3349d207d4
k8s.io/klog/v2 v2.90.1
k8s.io/gengo/v2 v2.0.0-20250106234829-0359904fc2a6
k8s.io/klog/v2 v2.130.1
)

require (
github.com/go-logr/logr v1.4.1 // indirect
golang.org/x/mod v0.14.0 // indirect
golang.org/x/tools v0.16.1 // indirect
)
57 changes: 14 additions & 43 deletions go.sum
Original file line number Diff line number Diff line change
@@ -1,45 +1,16 @@
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/go-logr/logr v0.2.0/go.mod h1:z6/tIYblkpsD+a4lm/fGIIU9mZ+XfAiaFtq7xTgseGU=
github.com/go-logr/logr v1.2.0/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=
github.com/go-logr/logr v1.2.4 h1:g01GSCwiDw2xSZfjJ2/T9M+S6pFdcNtFYsp+Y43HYDQ=
github.com/go-logr/logr v1.2.4/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=
github.com/google/go-cmp v0.4.0 h1:xsAVV57WRhGj6kEIi8ReJzQlHHqcBYCElAvkovg3B/4=
github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
github.com/google/gofuzz v1.1.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
github.com/kr/pretty v0.2.0/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
github.com/go-logr/logr v1.4.1 h1:pKouT5E8xu9zeFC39JXRDukb6JFQPXM5p5I91188VAQ=
github.com/go-logr/logr v1.4.1/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=
github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
golang.org/x/mod v0.2.0 h1:KU7oHjnv3XNWfa5COkzUifxZmxp1TyI7ImMXqFxLwvQ=
golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
golang.org/x/net v0.0.0-20200226121028-0de0cce0169b/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
golang.org/x/tools v0.0.0-20200505023115-26f46d2f7ef8 h1:BMFHd4OFnFtWX46Xj4DN6vvT1btiBxyq+s0orYBqcQY=
golang.org/x/tools v0.0.0-20200505023115-26f46d2f7ef8/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE=
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
k8s.io/gengo v0.0.0-20230306165830-ab3349d207d4 h1:aClvVG6GbX10ISHcc24J+tqbr0S7fEe1MWkFJ7cWWCI=
k8s.io/gengo v0.0.0-20230306165830-ab3349d207d4/go.mod h1:FiNAH4ZV3gBg2Kwh89tzAEV2be7d5xI0vBa/VySYy3E=
k8s.io/klog/v2 v2.2.0/go.mod h1:Od+F08eJP+W3HUb4pSrPpgp9DGU4GzlpG/TmITuYh/Y=
k8s.io/klog/v2 v2.90.1 h1:m4bYOKall2MmOiRaR1J+We67Do7vm9KiQVlT96lnHUw=
k8s.io/klog/v2 v2.90.1/go.mod h1:y1WjHnz7Dj687irZUWR/WLkLc5N1YHtjLdmgWjndZn0=
sigs.k8s.io/yaml v1.2.0/go.mod h1:yfXDCHCao9+ENCvLSE62v9VSji2MKu5jeNfTrofGhJc=
golang.org/x/mod v0.14.0 h1:dGoOF9QVLYng8IHTm7BAyWqCqSheQ5pYWGhzW00YJr0=
golang.org/x/mod v0.14.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
golang.org/x/sync v0.5.0 h1:60k92dhOjHxJkrqnwsfl8KuaHbn/5dl0lUPUklKo3qE=
golang.org/x/sync v0.5.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
golang.org/x/tools v0.16.1 h1:TLyB3WofjdOEepBHAU20JdNC1Zbg87elYofWYAY5oZA=
golang.org/x/tools v0.16.1/go.mod h1:kYVVN6I1mBNoB1OX+noeBjbRk4IUEPa7JJ+TJMEooJ0=
k8s.io/gengo/v2 v2.0.0-20250106234829-0359904fc2a6 h1:SdzkGIk4b5LFkVO36PuO0Bx4tpBDJDpNN0F1/v8JM5c=
k8s.io/gengo/v2 v2.0.0-20250106234829-0359904fc2a6/go.mod h1:EJykeLsmFC60UQbYJezXkEsG2FLrt0GPNkU5iK5GWxU=
k8s.io/klog/v2 v2.130.1 h1:n9Xl7H1Xvksem4KFG4PYbdQCQxqc/tTUyrgXaOhHSzk=
k8s.io/klog/v2 v2.130.1/go.mod h1:3Jpz1GvMt720eyJH1ckRHK1EDfpxISzJ7I9OYgaDtPE=
Loading