From c65df5d7ea4f7fd1ffc2c3ddb5077ba1e62594ac Mon Sep 17 00:00:00 2001 From: Matthieu Vachon Date: Fri, 6 Jan 2023 14:30:25 -0500 Subject: [PATCH] Added release elements --- .gitignore | 2 + .goreleaser.yml | 76 +++++++++++ LICENSE | 202 ++++++++++++++++++++++++++++++ cmd/substreams-sink-files/main.go | 25 +++- devel/release.sh | 127 +++++++++++++++++++ substreams.yaml | 13 ++ 6 files changed, 439 insertions(+), 6 deletions(-) create mode 100644 .goreleaser.yml create mode 100644 LICENSE create mode 100755 devel/release.sh create mode 100644 substreams.yaml diff --git a/.gitignore b/.gitignore index d43c71d..170df53 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,7 @@ .envrc .idea .DS_Store +*.spkg +dist/ localdata/ state.yaml \ No newline at end of file diff --git a/.goreleaser.yml b/.goreleaser.yml new file mode 100644 index 0000000..cbcec44 --- /dev/null +++ b/.goreleaser.yml @@ -0,0 +1,76 @@ +project_name: substreams-sink-files + +release: + draft: true + github: + owner: streamingfast + name: substreams-sink-files + name_template: '{{.Tag}}' +builds: + - id: substreams-sink-files + goos: + - linux + - darwin + goarch: + - arm64 + - amd64 + targets: + - linux_amd64 + - darwin_amd64 + - darwin_arm64 + main: ./cmd/substreams-sink-files + ldflags: -s -w -X main.version={{.Version}} + binary: substreams-sink-files + +archives: + # fireeth + - name_template: '{{ .Binary }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}{{ if .Arm }}v{{ .Arm }}{{ end }}' + id: substreams-sink-files + builds: + - substreams-sink-files + replacements: + amd64: x86_64 + darwin: macOS + linux: linux + format: tar.gz + files: + - LICENSE + - README.md +snapshot: + name_template: '{{ .Tag }}-next' +checksum: + name_template: checksums.txt +changelog: + filters: + exclude: + - '^docs:' + - '^test:' + sort: asc +dist: dist +signs: +- cmd: keybase + args: + - sign + - --infile + - $artifact + - --binary + - --outfile + - $signature + - --detached + signature: ${artifact}.sig + artifacts: checksum +env_files: + github_token: ~/.config/goreleaser/github_token +brews: + - name: substreams-sink-files + ids: + - substreams-sink-files + tap: + owner: streamingfast + name: homebrew-tap + commit_author: + name: goreleaserbot + email: goreleaser@streamingfast.io + homepage: "https://github.com/streamingfast/substreams-sink-files" + description: "Substreams Sink tool to extract information to flat files" + license: "Apache-2.0" diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/cmd/substreams-sink-files/main.go b/cmd/substreams-sink-files/main.go index eaf13b0..d082750 100644 --- a/cmd/substreams-sink-files/main.go +++ b/cmd/substreams-sink-files/main.go @@ -3,6 +3,7 @@ package main import ( "fmt" "net/http" + "runtime/debug" "strings" "time" @@ -15,15 +16,9 @@ import ( "go.uber.org/zap" ) -// Commit sha1 value, injected via go build `ldflags` at build time -var commit = "" - // Version value, injected via go build `ldflags` at build time var version = "dev" -// Date value, injected via go build `ldflags` at build time -var date = "" - var zlog, tracer = logging.RootLogger("substreams-sink-files", "github.com/streamingfast/substreams-sink-files/cmd/substreams-sink-files") func init() { @@ -73,6 +68,14 @@ func main() { func ConfigureVersion() CommandOption { return CommandOptionFunc(func(cmd *cobra.Command) { + info, ok := debug.ReadBuildInfo() + if !ok { + panic("we should have been able to retrieve info from 'runtime/debug#ReadBuildInfo'") + } + + commit := findSetting("vcs.revision", info.Settings) + date := findSetting("vcs.time", info.Settings) + var labels []string if len(commit) >= 7 { labels = append(labels, fmt.Sprintf("Commit %s", commit[0:7])) @@ -89,3 +92,13 @@ func ConfigureVersion() CommandOption { } }) } + +func findSetting(key string, settings []debug.BuildSetting) (value string) { + for _, setting := range settings { + if setting.Key == key { + return setting.Value + } + } + + return "" +} diff --git a/devel/release.sh b/devel/release.sh new file mode 100755 index 0000000..e931354 --- /dev/null +++ b/devel/release.sh @@ -0,0 +1,127 @@ +#!/usr/bin/env bash + +ROOT="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && cd .. && pwd )" + +dry_run="" +force="false" + +main() { + pushd "$ROOT" &> /dev/null + + while getopts "hnf" opt; do + case $opt in + h) usage && exit 0;; + n) dry_run="true";; + f) force="true";; + \?) usage_error "Invalid option: -$OPTARG";; + esac + done + shift $((OPTIND-1)) + + verify_github_token + verify_keybase + + if [[ "$dry_run" == "true" && "$force" == "true" ]]; then + usage_error "Only one of -n (dry run) or -f (force) can be provided at a time" + fi + + version="$1"; shift + if [[ "$version" == "" ]]; then + printf "What version do you want to release (current latest is `git describe --tags --abbrev=0 2>/dev/null`)? " + read version + fi + + if [[ ! "$version" =~ ^v ]]; then + echo "Version $version is invalid, must start with a 'v'" + exit 1 + fi + + mode="Dry Run, use -f flag to switch to publishing mode" + if [[ "$force" == "true" ]]; then + mode="Publishing" + fi + + echo "About to release version tagged $version ($mode)" + sleep 3 + + if [[ "$force" == "true" ]]; then + echo "Pushing to ensure GitHub knowns about the latest commit(s)" + git push + fi + + args="--rm-dist" + if [[ "$force" == "false" ]]; then + args="--skip-publish --skip-validate $args" + fi + + set -e + git tag "$version" + set +e + + substreams package substreams.yaml + + goreleaser release $args + + if [[ $? -gt 0 || "$force" == "false" ]]; then + git tag -d "$version" + fi + + echo "Don't forget to upload `find . -name 'substreams-sink-files-*.spkg' | tr -d "\n"` to GitHub release page and to publish the release!" +} + +verify_github_token() { + if [[ ! -f "$HOME/.config/goreleaser/github_token" && "$GITHUB_TOKEN" = "" ]]; then + echo "No GitHub token could be found in enviornment variable GITHUB_TOKEN" + echo "nor at ~/.config/goreleaser/github_token." + echo "" + echo "You will need to create one on GitHub website and make it available through" + echo "one of the accept way mentionned above." + exit 1 + fi +} + +verify_keybase() { + if ! command keybase &> /dev/null; then + echo "Keybase is required to sign the release (the checksum of all the artifacts" + echo "to be precise)." + echo "" + echo "You will need to have it available ('brew install keybase' on Mac OS X) and" + echo "configure it, just setting your Git username and a password should be enough." + exit 1 + fi +} + +usage_error() { + message="$1" + exit_code="$2" + + echo "ERROR: $message" + echo "" + usage + exit ${exit_code:-1} +} + +usage() { + echo "usage: release.sh [-h] [-f] [-n] []" + echo "" + echo "Perform the necessary commands to perform a release of the project." + echo "The is optional, if not provided, you'll be asked the question." + echo "" + echo "The release being performed against GitHub, you need a valid GitHub API token" + echo "with the necessary rights to upload release and push to repositories. It needs to" + echo "be provided in file ~/.config/goreleaser/github_token or through an environment" + echo "variable GITHUB_TOKEN." + echo "" + echo "Keybase is required to sign the release (the checksum of all the artifacts" + echo "to be precise)." + echo "" + echo "You will need to have it available ('brew install keybase' on Mac OS X) and" + echo "configure it, just setting your Git username and a password should be enough." + echo "" + echo "Options" + echo " -f Run in write mode publishing the release to GitHub" + echo " -n Run in dry-run mode skipping validation and publishing" + echo " -h Display help about this script" +} + +main "$@" \ No newline at end of file diff --git a/substreams.yaml b/substreams.yaml new file mode 100644 index 0000000..b0259ec --- /dev/null +++ b/substreams.yaml @@ -0,0 +1,13 @@ +specVersion: v0.1.0 +package: + name: substreams_sink_files + version: v0.1.0 + url: https://github.com/streamingfast/substreams-sink-files + doc: | + Protobuf definitions for interacting with Substreams Sink Files binary tool + +protobuf: + files: + - substreams/sink/files/v1/files.proto + importPaths: + - ./proto