# README
TopData Package Service
About
- This is cli command written in Go that handles "Topdata Packages"
- aka "Topdata Release Manager"
- a Topdata Package is currently a "Shopware 6 Plugin", more to come.
- git repositories with branches are used for release management
- it is single CLI program with multiple commands and subcommands
- It has a webserver with JSON endpoints to be used for generating documentation pages (using mkdocs) and maybe for other services later
Compile and run the program
- Ensure you have Go installed on your machine.
- Clone this repository.
- Navigate to the project directory.
- Install the dependencies:
go mod tidy
- Compile and run the program (fast!):
go run .
Install binary on your machine
Assuming you have Go installed on your machine, you can install the binary with the following command:
go install github.com/topdata-software-gmbh/topdata-package-util@latest
this compiles the program and installs it in your $GOPATH/bin
directory.
CLI Commands
Run the program for exploring the commands:
go run main.go --help
Command Line Options
--webserver-config-file
- Set the path to the config file. Default is
webserver-config.yaml
.
- Set the path to the config file. Default is
--portfolio-file
- Set the path to the config file where the package list is defined. Default is
portfolio.yaml
.
- Set the path to the config file where the package list is defined. Default is
Webserver
The program has a built-in webserver for serving a JSON API, start it with:
go run main.go webserver
API Endpoints
http://localhost:8080/
- Welcome messagehttp://localhost:8080/ping
- Ponghttp://localhost:8080/repositories
- Returns a list of repositorieshttp://localhost:8080/repository-details/:name
- Returns details of a repository
TODO
- when creating a release zip, log it somewhere (release-log-path should be part of the config file)
- fix and refactor the webservice API
- make use of .sw-zip-blacklist when creating a release zip
- stats, see for example:
- pkg details: show sw6 store backend url: https://account.shopware.com/producer/plugins/123456
Security issues
If you think that you have found a security issue, please contact [email protected]
CHANGELOG:
2024-05-19: project name changed topdata-package-service -> topdata-package-util
Documentation
For more detailed information, please refer to the documentation.
# Packages
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author