From aaa8eaf6d0961fe5aa400a4043c8d5a2602b7816 Mon Sep 17 00:00:00 2001 From: George Shaw Date: Tue, 15 Feb 2022 09:53:31 -0800 Subject: [PATCH] fix: bootstrap v9 (#176) --- .circleci/config.yml | 11 ++++--- CODEOWNERS => .github/CODEOWNERS | 0 .github/pull_request_template.md | 4 ++- CONTRIBUTING.md | 56 +++++++++++++------------------- LICENSE | 3 +- README.md | 12 ++++++- bootstrap.lock | 6 ++-- service.yaml | 22 +++++++++++-- 8 files changed, 67 insertions(+), 47 deletions(-) rename CODEOWNERS => .github/CODEOWNERS (100%) diff --git a/.circleci/config.yml b/.circleci/config.yml index 263145f..6e73960 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -1,6 +1,6 @@ version: 2.1 orbs: - shared: getoutreach/shared@1.47.0 + shared: getoutreach/shared@1.49.6 # DEPRECATED: Use the devbase orb instead: # https://github.com/getoutreach/devbase/tree/main/orbs/shared @@ -71,7 +71,7 @@ jobs: name: Release command: ./scripts/shell-wrapper.sh ci/release/release.sh - trigger_documentation: + publish_docs: executor: name: shared/testbed-docker docker_tag: stable @@ -79,7 +79,7 @@ jobs: - shared/setup_environment - shared/with_go_cache - run: - name: Trigger Documentation Update + name: Publish Documentation command: ./scripts/shell-wrapper.sh ci/release/docs.sh workflows: @@ -121,10 +121,13 @@ workflows: - ghaccesstoken - docker-registry - npm-credentials - - trigger_documentation: + ###Block(circleTestContext) + ###EndBlock(circleTestContext) + - publish_docs: context: - ghaccesstoken - docker-registry + - confluence filters: branches: ignore: /.*/ diff --git a/CODEOWNERS b/.github/CODEOWNERS similarity index 100% rename from CODEOWNERS rename to .github/CODEOWNERS diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index d3becdd..b066ce6 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -12,7 +12,9 @@ -**JIRA ID**: XX-XX +## Jira ID + +[XX-XX] diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8494f8b..019050a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,48 +1,36 @@ -# localizer - - - - - -The following sections of CONTRIBUTING.md were generated with -[bootstrap](https://github.com/getoutreach/bootstrap) and are common to all -bootstrap services. +# localizer -## Dependencies + + -Make sure you've followed the [Launch Plan](https://outreach-io.atlassian.net/wiki/spaces/EN/pages/695698940/Launch+Plan). -[Set up bootstrap](https://outreach-io.atlassian.net/wiki/spaces/EN/pages/701596137/Services+Checklist) if you're planning on updating bootstrap files. +## Prerequisites - - + + ## Building and Testing - - + + +### Replacing a Remote Version of the Library with Local Version + +If you want to test the library exposed in this repository in a project that uses it, you can +add the following `replace` directive to that project's `go.mod` file: -### Building (Locally) +``` +replace github.com/getoutreach/localizer => /path/to/local/version/localizer +``` -To produce binaries in the `./bin/` folder, run `make build`. +**_Note_**: This library may have postfixed it's module path with a version, go check the first +line of the `go.mod` file in this repository to see if that is the case. If that is the case, +you will need to modify the first part of the replace directive (the part before the `=>`) with +that postfixed path. -### Unit Testing +### Linting and Unit Testing -You can run the tests with: +You can run the the linters and unit tests with: ```bash make test -``` - - -## Releasing - -Making releases for this repository follows the process in the [Bootstrap](https://github.com/getoutreach/bootstrap/tree/master/README.md#semver) documentation. +``` \ No newline at end of file diff --git a/LICENSE b/LICENSE index 261eeb9..7a4a3ea 100644 --- a/LICENSE +++ b/LICENSE @@ -1,3 +1,4 @@ + Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ @@ -198,4 +199,4 @@ 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. + limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md index 884bad6..a4d7a20 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,17 @@ + # localizer +[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white)](https://pkg.go.dev/github.com/getoutreach/localizer) +[![Generated via Bootstrap](https://img.shields.io/badge/Outreach-Bootstrap-%235951ff)](https://github.com/getoutreach/bootstrap) A no-frills local development approach for Kubernetes powered Developer Environments. -## Why another CLI tool? +## Contributing + +Please read the [CONTRIBUTING.md](CONTRIBUTING.md) document for guidelines on developing and contributing changes. +## High-level Overview + + Tools such as; Telepresence, Skaffold, and others all attempt to solve the problem of getting users used to using Kubernetes. This is a pretty big task given that Kubernetes has a gigantic surface area. From my experience (**keyword**: _my experience_), developers have no interest in what @@ -67,3 +75,5 @@ Outside of WSL? Not currently. PRs are welcome! ## License Apache-2.0 + + diff --git a/bootstrap.lock b/bootstrap.lock index e140e51..c490acc 100644 --- a/bootstrap.lock +++ b/bootstrap.lock @@ -1,6 +1,6 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. # vim: set syntax=yaml: -version: v8.45.2 -generated: 2022-02-05T07:02:41Z +version: v9.1.6 +generated: 2022-02-15T10:17:06Z versions: - devbase: v1.47.0 + devbase: v1.49.6 diff --git a/service.yaml b/service.yaml index 42e69dd..9fdb9d3 100644 --- a/service.yaml +++ b/service.yaml @@ -1,21 +1,37 @@ name: localizer reportingTeam: fnd-dtss -description: "" +description: A no-frills local development approach for Kubernetes powered Developer Environments. oss: true slack: "" library: true commands: - localizer +circleAPIKey: "" releaseType: "" deployTo: environments: [] arguments: + circleAPIKey: "" dependencies: optional: [] required: [] - description: "" + description: A no-frills local development approach for Kubernetes powered Developer Environments. + opslevel: + confluenceSpaceKey: DTSS + designDocumentLink: "" + oss: true reportingTeam: fnd-dtss - type: [] + type: + - library modules: - url: https://github.com/getoutreach/stencil-base version: "" +opsLevel: + serviceTier: 0 + lifecycle: "" + confluenceSpaceKey: DTSS + pagerDutyLink: "" + datadogDashboards: + mainLink: "" + custom: [] + designDocumentLink: ""