Skip to content

Commit

Permalink
fix: bootstrap v9 (#176)
Browse files Browse the repository at this point in the history
  • Loading branch information
george-e-shaw-iv authored Feb 15, 2022
1 parent 1abc14e commit aaa8eaf
Show file tree
Hide file tree
Showing 8 changed files with 67 additions and 47 deletions.
11 changes: 7 additions & 4 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -71,15 +71,15 @@ jobs:
name: Release
command: ./scripts/shell-wrapper.sh ci/release/release.sh

trigger_documentation:
publish_docs:
executor:
name: shared/testbed-docker
docker_tag: stable
steps:
- 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:
Expand Down Expand Up @@ -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: /.*/
Expand Down
File renamed without changes.
4 changes: 3 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@


<!--- Block(jiraPrefix) --->
**JIRA ID**: XX-XX
## Jira ID

[XX-XX]
<!--- EndBlock(jiraPrefix) --->

<!-- Notes that may be helpful for anyone reviewing this PR -->
Expand Down
56 changes: 22 additions & 34 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,36 @@
# localizer

<!--- Block(custom) -->
<!--
We expect CONTRIBUTING.md to look mostly identical for all bootstrap services.
If your service requires special instructions for developers, you can place
those instructions in this block. If your service isn't special, it's safe to
leave this comment here as-is.

If the text you are about to add here applies to many or all bootstrap services,
consider adding it to the bootstrap template instead.
-->
<!--- EndBlock(custom) -->

The following sections of CONTRIBUTING.md were generated with
[bootstrap](https://github.com/getoutreach/bootstrap) and are common to all
bootstrap services.
# localizer

## Dependencies
<!--- Block(customGeneralInformation) -->
<!--- EndBlock(customGeneralInformation) -->

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

<!--- Block(devDependencies) -->
<!--- EndBlock(devDependencies) -->
<!-- Block(customPrerequisites) -->
<!-- EndBlock(customPrerequisites) -->

## Building and Testing

<!--- Block(buildCustom) -->
<!--- EndBlock(buildCustom) -->
<!-- Block(customBuildingAndTesting) -->
<!-- EndBlock(customBuildingAndTesting) -->
### 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.
```
3 changes: 2 additions & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
Expand Down Expand Up @@ -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.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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

<!--- Block(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
Expand Down Expand Up @@ -67,3 +75,5 @@ Outside of WSL? Not currently. PRs are welcome!
## License

Apache-2.0

<!--- EndBlock(overview) -->
6 changes: 3 additions & 3 deletions bootstrap.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 19 additions & 3 deletions service.yaml
Original file line number Diff line number Diff line change
@@ -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: ""

0 comments on commit aaa8eaf

Please sign in to comment.