Skip to content

Commit

Permalink
docs: updates module and name from uor-client-go to emporous-go
Browse files Browse the repository at this point in the history
Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>
  • Loading branch information
jpower432 committed Jan 12, 2023
1 parent fb73d05 commit c0570b5
Show file tree
Hide file tree
Showing 169 changed files with 630 additions and 636 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Bug report
about: Create a bug report to help improve the UOR client
about: Create a bug report to help improve the emporous client
title: ''
labels: bug
assignees: ''
Expand Down Expand Up @@ -28,7 +28,7 @@ Briefly describe the problem you are having in a few paragraphs.

**Describe the results you expected:**

**What version of the UOR client are you using:**
**What version of the emporous client are you using:**
<!--
Output of "uor-client-go version"
Output of "emporous version"
-->
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
blank_issues_enabled: true
contact_links:
- name: Ask a question (GitHub Discussions)
url: https://github.com/uor-framework/uor-client-go/discussions
url: https://github.com/emporous/emporous-go/discussions
about: |
Please do not submit "a bug report" for asking a question.
In most cases, GitHub Discussions is the best place to ask a question.
If you are not sure whether you are going to report a bug or ask a question,
please consider asking in GitHub Discussions first.
- name: Chat with uor-framework users and developers
- name: Chat with emporous users and developers
url: https://slack.cncf.io/
about: CNCF slack has the `#uor-framework` channel
about: CNCF slack has the `#emporous` channel
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Feature request
about: Suggest an idea for the UOR Client
about: Suggest an idea for the emporous Client
title: ''
labels: enhancement
assignees: ''
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,22 +55,22 @@ jobs:
-
uses: actions/checkout@v3
with:
path: src/github.com/uor-framework/uor-client-go
path: src/github.com/emporous/emporous-go
-
name: verify go modules and vendor directory
run: |
make vendor
working-directory: src/github.com/uor-framework/uor-client-go
working-directory: src/github.com/emporous/emporous-go
-
name: running unit tests
run: |
make test-unit
working-directory: src/github.com/uor-framework/uor-client-go
working-directory: src/github.com/emporous/emporous-go
-
name: running sanity checks
run: |
make sanity
working-directory: src/github.com/uor-framework/uor-client-go
working-directory: src/github.com/emporous/emporous-go

# Release
release:
Expand Down
28 changes: 14 additions & 14 deletions .goreleaser.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
project_name: uor-client-go
project_name: emporous

env:
- GO111MODULE=on
Expand All @@ -10,7 +10,7 @@ before:
- go mod vendor
builds:
-
binary: uor-client-go-{{ .Os }}-{{ .Arch }}
binary: emporous-{{ .Os }}-{{ .Arch }}
no_unique_dist_dir: true
main: ./cmd/client
flags:
Expand Down Expand Up @@ -44,14 +44,14 @@ builds:
- goos: darwin
goarch: ppc64le
ldflags:
- "-X github.com/uor-framework/uor-client-go/cli.version={{ .Tag }}"
- "-X github.com/uor-framework/uor-client-go/cli.commit={{ .ShortCommit }}"
- "-X github.com/uor-framework/uor-client-go/cli.buildDate={{ .Date }}"
- "-X github.com/emporous/emporous-go/cli.version={{ .Tag }}"
- "-X github.com/emporous/emporous-go/cli.commit={{ .ShortCommit }}"
- "-X github.com/emporous/emporous-go/cli.buildDate={{ .Date }}"
env:
- CGO_ENABLED=0

signs:
- id: uor-client-go-keyless
- id: emporous-keyless
signature: "${artifact}.sig"
certificate: "${artifact}.pem"
env:
Expand Down Expand Up @@ -115,14 +115,14 @@ dockers:
- --label=org.opencontainers.image.licenses=APACHE2.0

docker_manifests:
- name_template: ghcr.io/{{ .Env.GITHUB_REPOSITORY_OWNER }}/uor-client-go:{{ .Tag }}
- name_template: ghcr.io/{{ .Env.GITHUB_REPOSITORY_OWNER }}/emporous:{{ .Tag }}
image_templates:
- ghcr.io/{{ .Env.GITHUB_REPOSITORY_OWNER }}/uor-client-go:{{ .Tag }}-amd64
- ghcr.io/{{ .Env.GITHUB_REPOSITORY_OWNER }}/uor-client-go:{{ .Tag }}-arm64
- name_template: ghcr.io/{{ .Env.GITHUB_REPOSITORY_OWNER }}/uor-client-go:latest
- ghcr.io/{{ .Env.GITHUB_REPOSITORY_OWNER }}/emporous:{{ .Tag }}-amd64
- ghcr.io/{{ .Env.GITHUB_REPOSITORY_OWNER }}/emporous:{{ .Tag }}-arm64
- name_template: ghcr.io/{{ .Env.GITHUB_REPOSITORY_OWNER }}/emporous:latest
image_templates:
- ghcr.io/{{ .Env.GITHUB_REPOSITORY_OWNER }}/uor-client-go:{{ .Tag }}-amd64
- ghcr.io/{{ .Env.GITHUB_REPOSITORY_OWNER }}/uor-client-go:{{ .Tag }}-arm64
- ghcr.io/{{ .Env.GITHUB_REPOSITORY_OWNER }}/emporous:{{ .Tag }}-amd64
- ghcr.io/{{ .Env.GITHUB_REPOSITORY_OWNER }}/emporous:{{ .Tag }}-arm64

docker_signs:
- cmd: cosign
Expand Down Expand Up @@ -155,11 +155,11 @@ release:
prerelease: allow
github:
owner: "{{ .Env.GITHUB_REPOSITORY_OWNER }}"
name: uor-client-go
name: emporous
name_template: "{{.ProjectName}}-{{ .Tag }}"
header: |
## UOR Go Client {{ .Version }}
## Emporous Go Client {{ .Version }}
footer: |
Expand Down
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to the UOR Client and Libraries
# Contributing to the Emporous Client and Libraries

Thank you for investing your time in contributing to our project!

Expand All @@ -24,14 +24,14 @@ as to ensure the change aligns with the project's long-term plans.

### We Use [GitHub Flow](https://docs.github.com/en/get-started/quickstart/github-flow)

Please use the following workflow to make changes to the UOR Client codebase:
Please use the following workflow to make changes to the Emporous Client codebase:

1. Fork the repo and create your branch from `main`.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes (Run `make test-unit`)
5. Make sure your code lints (Run `make sanity`)
6. Create a pull request against the `uor-client-go` `main` branch.
6. Create a pull request against the `emporous` `main` branch.


When applicable, we encourage [draft pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request) for early feedback and better communication.
Expand All @@ -40,15 +40,15 @@ When applicable, we encourage [draft pull requests](https://docs.github.com/en/p
directory, run `make generate-protobuf`. This operation assumes the protobuf compiler and Go plugins are installed. If any changes are made
to the client CLI under `cmd/client`, run `make generate-usage-docs` to update the documentation under `docs/usage`.*

## Report bugs and feature ideas using GitHub's [issues](https://github.com/uor-framework/uor-client-go/issues/new/choose)
## Report bugs and feature ideas using GitHub's [issues](https://github.com/emporous/emporous-go/issues/new/choose)
Each issue type has a template attached to guide the submission.

## Code Styling

- Run `go fmt`
- Run [`golangci-lint`](https://github.com/golangci/golangci-lint)
- Use [`go-imports`](https://pkg.go.dev/golang.org/x/tools/cmd/goimports)
- (This should be configured to group the standard library, third-party, and uor-client-go module imports separately)
- (This should be configured to group the standard library, third-party, and emporous module imports separately)

## License
By contributing, you agree that your contributions will be licensed under its [Apache 2.0 License](https://choosealicense.com/licenses/apache-2.0/).
6 changes: 3 additions & 3 deletions Containerfile
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ FROM scratch
COPY --from=builder /rootfs/ /

ARG TARGETARCH
COPY uor-client-go-linux-${TARGETARCH} /usr/local/bin/uor-client-go
RUN set -ex && /usr/local/bin/uor-client-go version
COPY emporous-linux-${TARGETARCH} /usr/local/bin/emporous
RUN set -ex && /usr/local/bin/emporous version

ENTRYPOINT ["/usr/local/bin/uor-client-go"]
ENTRYPOINT ["/usr/local/bin/emporous"]
CMD ["version"]
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2022 UOR Framework Authors
Copyright 2022 Emporous Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
12 changes: 6 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@ GO := go

GO_BUILD_PACKAGES := ./cmd/client
GO_BUILD_BINDIR :=./bin
EXECUTABLE_NAME := "uor-client-go"
EXECUTABLE_NAME := "emporous"
GIT_COMMIT := $(or $(SOURCE_GIT_COMMIT),$(shell git rev-parse --short HEAD))
GIT_TAG :="$(shell git tag | sort -V | tail -1)"

GO_LD_EXTRAFLAGS :=-X github.com/uor-framework/uor-client-go/version.version="$(shell git tag | sort -V | tail -1)" \
-X github.com/uor-framework/uor-client-go/version.buildData="dev" \
-X github.com/uor-framework/uor-client-go/version.commit="$(GIT_COMMIT)" \
-X github.com/uor-framework/uor-client-go/version.buildDate="$(shell date -u +'%Y-%m-%dT%H:%M:%SZ')"
GO_LD_EXTRAFLAGS :=-X github.com/emporous/emporous-go/version.version="$(shell git tag | sort -V | tail -1)" \
-X github.com/emporous/emporous-go/version.buildData="dev" \
-X github.com/emporous/emporous-go/version.commit="$(GIT_COMMIT)" \
-X github.com/emporous/emporous-go/version.buildDate="$(shell date -u +'%Y-%m-%dT%H:%M:%SZ')"

build: prep-build-dir
$(GO) build -o $(GO_BUILD_BINDIR)/$(EXECUTABLE_NAME) -ldflags="$(GO_LD_EXTRAFLAGS)" $(GO_BUILD_PACKAGES)
Expand Down Expand Up @@ -81,7 +81,7 @@ vet:
.PHONY: vet

generate-usage-docs: prep-build-dir
# The gendoc executable is built with the name "uor-client-go" since the
# The gendoc executable is built with the name "emporous" since the
# root command name is built from the base path name of the cli
# at runtime.
$(GO) build -o $(GO_BUILD_BINDIR)/tmp/$(EXECUTABLE_NAME) "./cmd/gendoc"
Expand Down
Loading

0 comments on commit c0570b5

Please sign in to comment.