-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
18 changed files
with
188 additions
and
57 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Contributing | ||
|
||
## Requirements | ||
|
||
+ Go 1.21+ | ||
+ Make | ||
|
||
|
||
## Testing | ||
|
||
First ensure tests pass: | ||
|
||
```bash | ||
make test | ||
``` | ||
|
||
## Releasing | ||
|
||
Release a new version: | ||
|
||
```bash | ||
make build | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# These are supported funding model platforms | ||
|
||
github: [Halleck45] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
name: goreleaser | ||
|
||
on: | ||
push: | ||
# run only against tags | ||
tags: | ||
- "*" | ||
|
||
permissions: | ||
contents: write | ||
|
||
jobs: | ||
goreleaser: | ||
runs-on: ubuntu-latest | ||
steps: | ||
# Checkout the repository | ||
- uses: actions/checkout@v3 | ||
with: | ||
fetch-depth: 0 | ||
|
||
# Install go dependencies | ||
- uses: actions/setup-go@v4 | ||
with: | ||
go-version: stable | ||
|
||
# run tests | ||
- name: "Test application" | ||
run: go test | ||
|
||
# Build artifacts | ||
- uses: goreleaser/goreleaser-action@v5 | ||
with: | ||
distribution: goreleaser | ||
version: latest | ||
args: release --clean | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.PUSH_TOKEN }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
name: Go | ||
|
||
on: [push] | ||
|
||
jobs: | ||
test: | ||
|
||
runs-on: ubuntu-latest | ||
strategy: | ||
matrix: | ||
go-version: [ '1.21.x' ] | ||
|
||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- name: Setup Go ${{ matrix.go-version }} | ||
uses: actions/setup-go@v4 | ||
with: | ||
go-version: ${{ matrix.go-version }} | ||
cache-dependency-path: subdir/go.sum | ||
|
||
- name: Install Go dependencies | ||
run: go get . | ||
|
||
- name: Test with the Go CLI | ||
run: go test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,4 +4,5 @@ | |
env.sh | ||
pkg | ||
build | ||
bin | ||
bin | ||
dist |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
|
||
before: | ||
hooks: | ||
- go mod tidy | ||
- go generate ./... | ||
|
||
builds: | ||
- env: | ||
- CGO_ENABLED=0 | ||
goos: | ||
- linux | ||
- windows | ||
- darwin | ||
|
||
archives: | ||
- format: binary | ||
name_template: >- | ||
{{ .ProjectName }}_ | ||
{{- title .Os }}_ | ||
{{- if eq .Arch "amd64" }}x86_64 | ||
{{- else if eq .Arch "386" }}i386 | ||
{{- else }}{{ .Arch }}{{ end }} | ||
{{- if .Arm }}v{{ .Arm }}{{ end }} | ||
changelog: | ||
sort: asc | ||
filters: | ||
exclude: | ||
- "^docs:" | ||
- "^test:" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,8 @@ | ||
# OSS | ||
# OSS | ||
|
||
Tool for managing Open Source assets. | ||
|
||
## Why ? | ||
## Why ? | ||
|
||
Managing Open Source assets is a hard task in any project ; we often download awesome librairies, images or medias, but | ||
where to keep trace of all theses files ? How can I manage Open Source licenses of medias in my project ? | ||
|
@@ -11,48 +11,40 @@ That's the problem oss try to resolve today. | |
|
||
![simple overview of oss](./doc/overview.gif) | ||
|
||
## Installation | ||
## Installation | ||
|
||
Download binary for your platform: | ||
Download the binary for your platform from the [latest release](https://github.com/Halleck45/oss/releases/latest). | ||
|
||
+ Linux Debian: [64bits](http://dl.bintray.com/halleck45/OSS/oss_linux_amd64), [32bits](http://dl.bintray.com/halleck45/OSS/oss_linux_386) | ||
+ Windows: [64bits](http://dl.bintray.com/halleck45/OSS/oss_windows_amd64.exe), [32bits](http://dl.bintray.com/halleck45/OSS/oss_windows_386.exe) | ||
+ [Others platforms](http://dl.bintray.com/halleck45/OSS/) | ||
|
||
## Usage | ||
## Usage | ||
|
||
On first run, please execute | ||
|
||
oss init | ||
```bash | ||
oss init | ||
``` | ||
|
||
Then, you can use the following commands: | ||
|
||
+ **status**: list assets of the project | ||
+ **add** `<license>` `<file>` `[<description>]`: register new file | ||
+ **rm** `<file>`: unregister file | ||
+ **show** `<file>`: display information about the given file | ||
+ `oss `**`status`**: list assets of the project | ||
+ `oss `**`add`**` <license> <file> [<description>]`: register new file | ||
+ `oss `**`rm`**` <file>`: unregister file | ||
+ `oss `**`show`**` <file>`: display information about the given file | ||
|
||
Or to get information about SPDX licenses : | ||
|
||
+ **licenses**: list available licenses (base on the [SPDX license list]((http://spdx.org/licenses/))) | ||
+ **search** `<expression>`: Search licenses matching `expression` | ||
+ **update**: update SPDX license list | ||
+ `oss `**`licenses`**: list available licenses (base on the [SPDX license list]((http://spdx.org/licenses/))) | ||
+ `oss `**`search`**` <expression>`: Search licenses matching `expression` | ||
+ `oss `**`update`**: update SPDX license list | ||
|
||
Keep in mind that **the license identifier should be registered in [SPDX License list](http://spdx.org/licenses/)** | ||
|
||
## Copyright | ||
|
||
MIT License. Copyright (c) Jean-François Lépine. See LICENSE for details. | ||
|
||
## Contributing | ||
## Contributing | ||
|
||
|
||
clone [email protected]:Halleck45/OSS.git | ||
cd OSS | ||
make init && make install | ||
( ... your development ...) | ||
make build | ||
Cf. [CONTRIBUTING.md](./.github/CONTRIBUTING.md) | ||
|
||
Remember to keep tests up to date (and, of course, to run them with `make test`) | ||
|
||
Builds are hosted by [bintray](https://bintray.com). Today, only me (Halleck45) has permission to publish binaries. | ||
Remember to keep tests up to date (and, of course, to run them with `make test`) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
module github.com/halleck45/oss | ||
|
||
go 1.21 | ||
|
||
require ( | ||
github.com/dotcypress/phonetics v0.0.0-20141025200009-5cea56e8d200 | ||
github.com/stretchr/testify v1.9.0 | ||
) | ||
|
||
require ( | ||
github.com/davecgh/go-spew v1.1.1 // indirect | ||
github.com/pmezard/go-difflib v1.0.0 // indirect | ||
gopkg.in/yaml.v3 v3.0.1 // indirect | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
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/dotcypress/phonetics v0.0.0-20141025200009-5cea56e8d200 h1:3y43HNVcW0K++6HB7RsWIdulZ5zzrLYBBtPccYsqTdc= | ||
github.com/dotcypress/phonetics v0.0.0-20141025200009-5cea56e8d200/go.mod h1:nTAuszUNo9dUCKTwDLN9UDcO5UdL/MAOvmu5oM+5ozY= | ||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= | ||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= | ||
github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg= | ||
github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= | ||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= | ||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= | ||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= | ||
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.