Skip to content

Commit

Permalink
chore: cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
johnletey committed Aug 29, 2024
1 parent 7f5928e commit 17879c0
Show file tree
Hide file tree
Showing 18 changed files with 121 additions and 628 deletions.
3 changes: 3 additions & 0 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<h1 style="text-align: center">ADR36</h1>

[![codecov](https://img.shields.io/codecov/c/gh/noble-assets/adr36?token=4MKPLURKGG&labelColor=black)](https://codecov.io/gh/noble-assets/adr36)
6 changes: 6 additions & 0 deletions .github/license.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
header: |
// Copyright 2024 NASD Inc.
//
// Use of this source code is governed by an MIT-style
// license that can be found in the LICENSE file or at
// https://opensource.org/licenses/MIT.
45 changes: 45 additions & 0 deletions .github/workflows/deploy.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Deploy to GitHub Pages

on:
push:
branches:
- main

permissions:
contents: read
id-token: write
pages: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v4
- name: Setup Go
uses: actions/setup-go@v5

- name: Install Vangen
run: |
git clone https://github.com/noble-assets/vangen
cd vangen && go install && cd ..
rm -rf vangen
- name: Build Site
run: vangen

- name: Upload Artifacts
uses: actions/upload-pages-artifact@v3
with:
path: ./vangen

deploy:
runs-on: ubuntu-latest
needs: build
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 NASD Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
23 changes: 7 additions & 16 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,28 +1,19 @@
.PHONY: proto-format proto-lint proto-gen format lint test-unit
all: proto-all format lint test-unit
.PHONY: proto-format proto-lint proto-gen license test-unit
all: proto-all test-unit

###############################################################################
### Formatting & Linting ###
### Tooling ###
###############################################################################

gofumpt_cmd=mvdan.cc/gofumpt
golangci_lint_cmd=github.com/golangci/golangci-lint/cmd/golangci-lint

format:
@echo "🤖 Running formatter..."
@go run $(gofumpt_cmd) -l -w .
@echo "✅ Completed formatting!"

lint:
@echo "🤖 Running linter..."
@go run $(golangci_lint_cmd) run --timeout=10m
@echo "✅ Completed linting!"
FILES := $(shell find $(shell go list -f '{{.Dir}}' ./...) -name "*.go" -a -not -name "*.pb.go" -a -not -name "*.pb.gw.go" | sed "s|$(shell pwd)/||g")
license:
@go-license --config .github/license.yml $(FILES)

###############################################################################
### Protobuf ###
###############################################################################

BUF_VERSION=1.32
BUF_VERSION=1.39

proto-all: proto-format proto-lint proto-gen

Expand Down
1 change: 1 addition & 0 deletions buf.gen.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# yaml-language-server: $schema=https://json.schemastore.org/buf.gen.json
version: v1
plugins:
- name: gocosmos
Expand Down
1 change: 1 addition & 0 deletions buf.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# yaml-language-server: $schema=https://json.schemastore.org/buf.json
version: v2
modules:
- path: proto
Expand Down
1 change: 0 additions & 1 deletion docs/CNAME

This file was deleted.

25 changes: 0 additions & 25 deletions docs/index.html

This file was deleted.

Loading

0 comments on commit 17879c0

Please sign in to comment.