-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1abc14e
commit aaa8eaf
Showing
8 changed files
with
67 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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: "" |