You've already forked docker-hub-description-updater
Compare commits
10 Commits
905282adb5
...
master
Author | SHA1 | Date | |
---|---|---|---|
c551806f56 | |||
ff32c63ec0
|
|||
3d4e5d0e15 | |||
742a00d91d
|
|||
7425cfe2d0 | |||
ccd0d62503
|
|||
0bfc39536d | |||
32bc80cc49
|
|||
b0c90c4cb3
|
|||
b4dcb26b45
|
1
.dockerignore
Normal file
1
.dockerignore
Normal file
@ -0,0 +1 @@
|
||||
app
|
@ -1,12 +1,13 @@
|
||||
# Editor configuration, see http://editorconfig.org
|
||||
root = true
|
||||
|
||||
[*]
|
||||
indent_style = space
|
||||
indent_size = 2
|
||||
end_of_line = lf
|
||||
charset = utf-8
|
||||
trim_trailing_whitespace = true
|
||||
end_of_line = lf
|
||||
indent_size = 2
|
||||
indent_style = space
|
||||
insert_final_newline = false
|
||||
trim_trailing_whitespace = true
|
||||
|
||||
[Makefile]
|
||||
indent_style = tab
|
||||
[{Makefile,*.go}]
|
||||
indent_style = tab
|
||||
|
1
.gitattributes
vendored
1
.gitattributes
vendored
@ -1 +0,0 @@
|
||||
Makefile eol=lf
|
@ -1,4 +1,4 @@
|
||||
name: Golang CI lint
|
||||
name: "Lint Golang files"
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
@ -6,22 +6,24 @@ on:
|
||||
push:
|
||||
branches: [ '**' ]
|
||||
tags-ignore: [ '**' ]
|
||||
workflow_dispatch: {}
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
golangci:
|
||||
name: "Run golang CI linter"
|
||||
runs-on: ${{ matrix.os }}
|
||||
strategy:
|
||||
matrix:
|
||||
go: [ stable ]
|
||||
os: [ ubuntu-latest-amd64, ubuntu-latest-arm64 ]
|
||||
steps:
|
||||
- uses: actions/checkout@v5.0.0
|
||||
- uses: actions/checkout@v4.3.0
|
||||
- uses: actions/setup-go@v5.5.0
|
||||
with:
|
||||
go-version: ${{ matrix.go }}
|
||||
- uses: golangci/golangci-lint-action@v8.0.0
|
||||
with:
|
||||
version: v2.1
|
||||
version: v2.4.0 # renovate: datasource=github-releases depName=golangci/golangci-lint
|
@ -1,4 +1,4 @@
|
||||
name: Golang Tests
|
||||
name: "Run Golang tests"
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
@ -6,16 +6,34 @@ on:
|
||||
push:
|
||||
branches: [ '**' ]
|
||||
tags-ignore: [ '**' ]
|
||||
workflow_dispatch: {}
|
||||
|
||||
jobs:
|
||||
unittest:
|
||||
# integration-test:
|
||||
# name: "Run integration tests"
|
||||
# runs-on: ${{ matrix.os }}
|
||||
# strategy:
|
||||
# matrix:
|
||||
# go: [ stable ]
|
||||
# os: [ ubuntu-latest-amd64, ubuntu-latest-arm64 ]
|
||||
# steps:
|
||||
# - uses: actions/checkout@v4.3.0
|
||||
# - uses: actions/setup-go@v5.5.0
|
||||
# with:
|
||||
# go-version: ${{ matrix.go }}
|
||||
# - env:
|
||||
# GOPROXY: ${{ vars.GOPROXY }}
|
||||
# run: make test/integration
|
||||
|
||||
unit-test:
|
||||
name: "Run unit tests"
|
||||
runs-on: ${{ matrix.os }}
|
||||
strategy:
|
||||
matrix:
|
||||
go: [ stable ]
|
||||
os: [ ubuntu-latest-amd64, ubuntu-latest-arm64 ]
|
||||
steps:
|
||||
- uses: actions/checkout@v5.0.0
|
||||
- uses: actions/checkout@v4.3.0
|
||||
- uses: actions/setup-go@v5.5.0
|
||||
with:
|
||||
go-version: ${{ matrix.go }}
|
||||
|
@ -1,18 +1,19 @@
|
||||
name: Lint Markdown files
|
||||
name: "Lint Markdown files"
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
types: [ "opened", "reopened", "synchronize" ]
|
||||
push:
|
||||
branches: [ '**' ]
|
||||
tags-ignore: [ '**' ]
|
||||
branches: [ '*' ]
|
||||
tags-ignore: [ '*' ]
|
||||
workflow_dispatch: {}
|
||||
|
||||
jobs:
|
||||
markdown-lint:
|
||||
runs-on:
|
||||
- ubuntu-latest
|
||||
name: "Run markdown linter"
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v5.0.0
|
||||
- uses: actions/checkout@v4.3.0
|
||||
- uses: DavidAnson/markdownlint-cli2-action@v20.0.0
|
||||
with:
|
||||
globs: '**/*.md'
|
||||
globs: '**/*.md'
|
||||
|
@ -1,4 +1,4 @@
|
||||
name: Release
|
||||
name: "Release"
|
||||
|
||||
on:
|
||||
push:
|
||||
@ -9,15 +9,15 @@ permissions:
|
||||
|
||||
jobs:
|
||||
release:
|
||||
runs-on:
|
||||
- ubuntu-latest
|
||||
name: "Release application"
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v5.0.0
|
||||
- uses: actions/checkout@v4.3.0
|
||||
- uses: docker/setup-qemu-action@v3.6.0
|
||||
- uses: actions/setup-go@v5.5.0
|
||||
with:
|
||||
go-version: stable
|
||||
- uses: docker/login-action@v3.4.0
|
||||
- uses: docker/login-action@v3.5.0
|
||||
with:
|
||||
registry: git.cryptic.systems
|
||||
username: ${{ github.repository_owner }}
|
||||
@ -26,9 +26,9 @@ jobs:
|
||||
GITEA_TOKEN: ${{ secrets.GIT_CRYPTIC_SYSTEMS_PACKAGE_REGISTRY_TOKEN }}
|
||||
GONOSUMDB: ${{ vars.GONOSUMDB }}
|
||||
GOPROXY: ${{ vars.GOPROXY }}
|
||||
uses: goreleaser/goreleaser-action@v6.3.0
|
||||
uses: goreleaser/goreleaser-action@v6.4.0
|
||||
with:
|
||||
version: "~> v2"
|
||||
version: v2.11.2 # renovate: datasource=github-releases depName=goreleaser/goreleaser
|
||||
args: release --clean
|
||||
|
||||
sync-to-hub-docker-io:
|
||||
|
@ -11,7 +11,7 @@ jobs:
|
||||
runs-on:
|
||||
- ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v5.0.0
|
||||
- uses: actions/checkout@v4.3.0
|
||||
- uses: peter-evans/dockerhub-description@v4.0.2
|
||||
with:
|
||||
username: ${{ secrets.DOCKER_IO_USERNAME }}
|
||||
|
13
.golangci.yaml
Normal file
13
.golangci.yaml
Normal file
@ -0,0 +1,13 @@
|
||||
version: "2"
|
||||
linters:
|
||||
default: standard
|
||||
enable:
|
||||
- errname
|
||||
- gosec
|
||||
|
||||
exclusions:
|
||||
rules: []
|
||||
warn-unused: true
|
||||
|
||||
run:
|
||||
tests: true
|
136
.markdownlint.yaml
Normal file
136
.markdownlint.yaml
Normal file
@ -0,0 +1,136 @@
|
||||
# markdownlint YAML configuration
|
||||
# https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
|
||||
|
||||
# Default state for all rules
|
||||
default: true
|
||||
|
||||
# Path to configuration file to extend
|
||||
extends: null
|
||||
|
||||
# MD003/heading-style/header-style - Heading style
|
||||
MD003:
|
||||
# Heading style
|
||||
style: "atx"
|
||||
|
||||
# MD004/ul-style - Unordered list style
|
||||
MD004:
|
||||
style: "dash"
|
||||
|
||||
# MD007/ul-indent - Unordered list indentation
|
||||
MD007:
|
||||
# Spaces for indent
|
||||
indent: 2
|
||||
# Whether to indent the first level of the list
|
||||
start_indented: false
|
||||
|
||||
# MD009/no-trailing-spaces - Trailing spaces
|
||||
MD009:
|
||||
# Spaces for line break
|
||||
br_spaces: 2
|
||||
# Allow spaces for empty lines in list items
|
||||
list_item_empty_lines: false
|
||||
# Include unnecessary breaks
|
||||
strict: false
|
||||
|
||||
# MD010/no-hard-tabs - Hard tabs
|
||||
MD010:
|
||||
# Include code blocks
|
||||
code_blocks: true
|
||||
|
||||
# MD012/no-multiple-blanks - Multiple consecutive blank lines
|
||||
MD012:
|
||||
# Consecutive blank lines
|
||||
maximum: 1
|
||||
|
||||
# MD013/line-length - Line length
|
||||
MD013:
|
||||
# Number of characters
|
||||
line_length: 120
|
||||
# Number of characters for headings
|
||||
heading_line_length: 120
|
||||
# Number of characters for code blocks
|
||||
code_block_line_length: 120
|
||||
# Include code blocks
|
||||
code_blocks: false
|
||||
# Include tables
|
||||
tables: false
|
||||
# Include headings
|
||||
headings: true
|
||||
# Strict length checking
|
||||
strict: false
|
||||
# Stern length checking
|
||||
stern: false
|
||||
|
||||
# MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines
|
||||
MD022:
|
||||
# Blank lines above heading
|
||||
lines_above: 1
|
||||
# Blank lines below heading
|
||||
lines_below: 1
|
||||
|
||||
# MD025/single-title/single-h1 - Multiple top-level headings in the same document
|
||||
MD025:
|
||||
# Heading level
|
||||
level: 1
|
||||
# RegExp for matching title in front matter
|
||||
front_matter_title: "^\\s*title\\s*[:=]"
|
||||
|
||||
# MD026/no-trailing-punctuation - Trailing punctuation in heading
|
||||
MD026:
|
||||
# Punctuation characters
|
||||
punctuation: ".,;:!。,;:!"
|
||||
|
||||
# MD029/ol-prefix - Ordered list item prefix
|
||||
MD029:
|
||||
# List style
|
||||
style: "one_or_ordered"
|
||||
|
||||
# MD030/list-marker-space - Spaces after list markers
|
||||
MD030:
|
||||
# Spaces for single-line unordered list items
|
||||
ul_single: 1
|
||||
# Spaces for single-line ordered list items
|
||||
ol_single: 1
|
||||
# Spaces for multi-line unordered list items
|
||||
ul_multi: 1
|
||||
# Spaces for multi-line ordered list items
|
||||
ol_multi: 1
|
||||
|
||||
# MD033/no-inline-html - Inline HTML
|
||||
MD033:
|
||||
# Allowed elements
|
||||
allowed_elements: []
|
||||
|
||||
# MD035/hr-style - Horizontal rule style
|
||||
MD035:
|
||||
# Horizontal rule style
|
||||
style: "---"
|
||||
|
||||
# MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading
|
||||
MD036:
|
||||
# Punctuation characters
|
||||
punctuation: ".,;:!?。,;:!?"
|
||||
|
||||
# MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading
|
||||
MD041:
|
||||
# Heading level
|
||||
level: 1
|
||||
# RegExp for matching title in front matter
|
||||
front_matter_title: "^\\s*title\\s*[:=]"
|
||||
|
||||
# MD044/proper-names - Proper names should have the correct capitalization
|
||||
MD044:
|
||||
# List of proper names
|
||||
names: []
|
||||
# Include code blocks
|
||||
code_blocks: false
|
||||
|
||||
# MD046/code-block-style - Code block style
|
||||
MD046:
|
||||
# Block style
|
||||
style: "fenced"
|
||||
|
||||
# MD048/code-fence-style - Code fence style
|
||||
MD048:
|
||||
# Code fence syle
|
||||
style: "backtick"
|
@ -2,7 +2,6 @@ package cmd
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"io/ioutil"
|
||||
"log"
|
||||
"os"
|
||||
|
||||
@ -59,7 +58,8 @@ func runE(cmd *cobra.Command, args []string) error {
|
||||
return fmt.Errorf("can not find file: %v", file)
|
||||
}
|
||||
|
||||
f, err := ioutil.ReadFile(file)
|
||||
// #nosec G304
|
||||
f, err := os.ReadFile(file)
|
||||
if err != nil {
|
||||
return fmt.Errorf("can not read file %v: %v", file, err)
|
||||
}
|
||||
|
@ -3,11 +3,11 @@ package hub
|
||||
import "errors"
|
||||
|
||||
var (
|
||||
errorFailedToCreateRequest = errors.New("failed to create http request")
|
||||
errorFailedToParseJSON = errors.New("failed to parse json")
|
||||
errorFailedToParseURL = errors.New("failed to parse url")
|
||||
errorFailedToSendRequest = errors.New("failed to send http request")
|
||||
errorNoNamespaceDefined = errors.New("no Namespace defined")
|
||||
errorNoRepositoryDefined = errors.New("no Repository defined")
|
||||
errorUnexpectedHTTPStatuscode = errors.New("unexpected HTTP-Statuscode")
|
||||
errFailedToCreateRequest = errors.New("failed to create http request")
|
||||
errFailedToParseJSON = errors.New("failed to parse json")
|
||||
errFailedToParseURL = errors.New("failed to parse url")
|
||||
errFailedToSendRequest = errors.New("failed to send http request")
|
||||
errNoNamespaceDefined = errors.New("no Namespace defined")
|
||||
errNoRepositoryDefined = errors.New("no Repository defined")
|
||||
errUnexpectedHTTPStatuscode = errors.New("unexpected HTTP-Statuscode")
|
||||
)
|
||||
|
@ -25,22 +25,22 @@ type Hub struct {
|
||||
func (h *Hub) GetRepository(namespace string, name string) (*types.Repository, error) {
|
||||
|
||||
if len(namespace) <= 0 {
|
||||
return nil, errorNoNamespaceDefined
|
||||
return nil, errNoNamespaceDefined
|
||||
}
|
||||
|
||||
if len(name) <= 0 {
|
||||
return nil, errorNoRepositoryDefined
|
||||
return nil, errNoRepositoryDefined
|
||||
}
|
||||
|
||||
rawURL := fmt.Sprintf("%v/repositories/%v/%v", dockerHubAPI, namespace, name)
|
||||
url, err := url.Parse(rawURL)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("%v: %v", errorFailedToParseURL, err)
|
||||
return nil, fmt.Errorf("%v: %v", errFailedToParseURL, err)
|
||||
}
|
||||
|
||||
req, err := http.NewRequest(http.MethodGet, url.String(), nil)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("%v: %v", errorFailedToCreateRequest, err)
|
||||
return nil, fmt.Errorf("%v: %v", errFailedToCreateRequest, err)
|
||||
}
|
||||
|
||||
if h.token == nil {
|
||||
@ -54,18 +54,18 @@ func (h *Hub) GetRepository(namespace string, name string) (*types.Repository, e
|
||||
|
||||
resp, err := h.client.Do(req)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("%v: %v", errorFailedToSendRequest, err)
|
||||
return nil, fmt.Errorf("%v: %v", errFailedToSendRequest, err)
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return nil, fmt.Errorf("%v: expect %v, received %v", errorUnexpectedHTTPStatuscode, http.StatusOK, resp.StatusCode)
|
||||
return nil, fmt.Errorf("%v: expect %v, received %v", errUnexpectedHTTPStatuscode, http.StatusOK, resp.StatusCode)
|
||||
}
|
||||
|
||||
repository := new(types.Repository)
|
||||
jsonDecoder := json.NewDecoder(resp.Body)
|
||||
if err := jsonDecoder.Decode(repository); err != nil {
|
||||
return nil, fmt.Errorf("%v: %v", errorFailedToParseJSON, err)
|
||||
return nil, fmt.Errorf("%v: %v", errFailedToParseJSON, err)
|
||||
}
|
||||
|
||||
return repository, nil
|
||||
@ -75,30 +75,30 @@ func (h *Hub) getToken() (*types.Token, error) {
|
||||
loginBuffer := new(bytes.Buffer)
|
||||
jsonEncoder := json.NewEncoder(loginBuffer)
|
||||
if err := jsonEncoder.Encode(h.credentials); err != nil {
|
||||
return nil, fmt.Errorf("%v: %v", errorFailedToParseJSON, err)
|
||||
return nil, fmt.Errorf("%v: %v", errFailedToParseJSON, err)
|
||||
}
|
||||
|
||||
rawURL := fmt.Sprintf("%v/users/login/", dockerHubAPI)
|
||||
req, err := http.NewRequest(http.MethodPost, rawURL, loginBuffer)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("%v: %v", errorFailedToCreateRequest, err)
|
||||
return nil, fmt.Errorf("%v: %v", errFailedToCreateRequest, err)
|
||||
}
|
||||
req.Header.Add("Content-Type", "application/json")
|
||||
|
||||
resp, err := h.client.Do(req)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("%v: %v", errorFailedToCreateRequest, err)
|
||||
return nil, fmt.Errorf("%v: %v", errFailedToCreateRequest, err)
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return nil, fmt.Errorf("%v: expect %v, received %v", errorUnexpectedHTTPStatuscode, http.StatusOK, resp.StatusCode)
|
||||
return nil, fmt.Errorf("%v: expect %v, received %v", errUnexpectedHTTPStatuscode, http.StatusOK, resp.StatusCode)
|
||||
}
|
||||
|
||||
token := new(types.Token)
|
||||
jsonDecoder := json.NewDecoder(resp.Body)
|
||||
if err := jsonDecoder.Decode(token); err != nil {
|
||||
return nil, fmt.Errorf("%v: %v", errorFailedToParseJSON, err)
|
||||
return nil, fmt.Errorf("%v: %v", errFailedToParseJSON, err)
|
||||
}
|
||||
|
||||
return token, nil
|
||||
@ -108,11 +108,11 @@ func (h *Hub) getToken() (*types.Token, error) {
|
||||
func (h *Hub) PatchRepository(repository *types.Repository) (*types.Repository, error) {
|
||||
|
||||
if len(repository.Namespcace) <= 0 {
|
||||
return nil, errorNoNamespaceDefined
|
||||
return nil, errNoNamespaceDefined
|
||||
}
|
||||
|
||||
if len(repository.Name) <= 0 {
|
||||
return nil, errorNoRepositoryDefined
|
||||
return nil, errNoRepositoryDefined
|
||||
}
|
||||
|
||||
if h.token == nil {
|
||||
@ -127,7 +127,7 @@ func (h *Hub) PatchRepository(repository *types.Repository) (*types.Repository,
|
||||
rawURL := fmt.Sprintf("%v/repositories/%v/%v", dockerHubAPI, repository.Namespcace, repository.Name)
|
||||
patchURL, err := url.Parse(rawURL)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("%v: %v", errorFailedToParseURL, err)
|
||||
return nil, fmt.Errorf("%v: %v", errFailedToParseURL, err)
|
||||
}
|
||||
|
||||
data := &url.Values{}
|
||||
@ -136,24 +136,24 @@ func (h *Hub) PatchRepository(repository *types.Repository) (*types.Repository,
|
||||
|
||||
req, err := http.NewRequest(http.MethodPatch, patchURL.String(), nil)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("%v: %v", errorFailedToCreateRequest, err)
|
||||
return nil, fmt.Errorf("%v: %v", errFailedToCreateRequest, err)
|
||||
}
|
||||
req.Header.Set("Authorization", fmt.Sprintf("JWT %v", h.token.Token))
|
||||
|
||||
resp, err := h.client.Do(req)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("%v: %v", errorFailedToCreateRequest, err)
|
||||
return nil, fmt.Errorf("%v: %v", errFailedToCreateRequest, err)
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return nil, fmt.Errorf("%v: expect %v, received %v", errorUnexpectedHTTPStatuscode, http.StatusOK, resp.StatusCode)
|
||||
return nil, fmt.Errorf("%v: expect %v, received %v", errUnexpectedHTTPStatuscode, http.StatusOK, resp.StatusCode)
|
||||
}
|
||||
|
||||
patchedRepository := new(types.Repository)
|
||||
jsonDecoder := json.NewDecoder(resp.Body)
|
||||
if err := jsonDecoder.Decode(h.token); err != nil {
|
||||
return nil, fmt.Errorf("%v: %v", errorFailedToParseJSON, err)
|
||||
return nil, fmt.Errorf("%v: %v", errFailedToParseJSON, err)
|
||||
}
|
||||
|
||||
return patchedRepository, nil
|
||||
|
Reference in New Issue
Block a user