Skip to content

Commit aaa8eaf

Browse files
fix: bootstrap v9 (#176)
1 parent 1abc14e commit aaa8eaf

File tree

8 files changed

+67
-47
lines changed

8 files changed

+67
-47
lines changed

.circleci/config.yml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
version: 2.1
22
orbs:
3-
shared: getoutreach/shared@1.47.0
3+
shared: getoutreach/shared@1.49.6
44

55
# DEPRECATED: Use the devbase orb instead:
66
# https://github.com/getoutreach/devbase/tree/main/orbs/shared
@@ -71,15 +71,15 @@ jobs:
7171
name: Release
7272
command: ./scripts/shell-wrapper.sh ci/release/release.sh
7373

74-
trigger_documentation:
74+
publish_docs:
7575
executor:
7676
name: shared/testbed-docker
7777
docker_tag: stable
7878
steps:
7979
- shared/setup_environment
8080
- shared/with_go_cache
8181
- run:
82-
name: Trigger Documentation Update
82+
name: Publish Documentation
8383
command: ./scripts/shell-wrapper.sh ci/release/docs.sh
8484

8585
workflows:
@@ -121,10 +121,13 @@ workflows:
121121
- ghaccesstoken
122122
- docker-registry
123123
- npm-credentials
124-
- trigger_documentation:
124+
###Block(circleTestContext)
125+
###EndBlock(circleTestContext)
126+
- publish_docs:
125127
context:
126128
- ghaccesstoken
127129
- docker-registry
130+
- confluence
128131
filters:
129132
branches:
130133
ignore: /.*/
File renamed without changes.

.github/pull_request_template.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@
1212

1313

1414
<!--- Block(jiraPrefix) --->
15-
**JIRA ID**: XX-XX
15+
## Jira ID
16+
17+
[XX-XX]
1618
<!--- EndBlock(jiraPrefix) --->
1719

1820
<!-- Notes that may be helpful for anyone reviewing this PR -->

CONTRIBUTING.md

Lines changed: 22 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,36 @@
1-
# localizer
2-
3-
<!--- Block(custom) -->
4-
<!--
5-
We expect CONTRIBUTING.md to look mostly identical for all bootstrap services.
6-
7-
If your service requires special instructions for developers, you can place
8-
those instructions in this block. If your service isn't special, it's safe to
9-
leave this comment here as-is.
101

11-
If the text you are about to add here applies to many or all bootstrap services,
12-
consider adding it to the bootstrap template instead.
13-
-->
14-
<!--- EndBlock(custom) -->
15-
16-
The following sections of CONTRIBUTING.md were generated with
17-
[bootstrap](https://github.com/getoutreach/bootstrap) and are common to all
18-
bootstrap services.
2+
# localizer
193

20-
## Dependencies
4+
<!--- Block(customGeneralInformation) -->
5+
<!--- EndBlock(customGeneralInformation) -->
216

22-
Make sure you've followed the [Launch Plan](https://outreach-io.atlassian.net/wiki/spaces/EN/pages/695698940/Launch+Plan).
23-
[Set up bootstrap](https://outreach-io.atlassian.net/wiki/spaces/EN/pages/701596137/Services+Checklist) if you're planning on updating bootstrap files.
7+
## Prerequisites
248

25-
<!--- Block(devDependencies) -->
26-
<!--- EndBlock(devDependencies) -->
9+
<!-- Block(customPrerequisites) -->
10+
<!-- EndBlock(customPrerequisites) -->
2711

2812
## Building and Testing
2913

30-
<!--- Block(buildCustom) -->
31-
<!--- EndBlock(buildCustom) -->
14+
<!-- Block(customBuildingAndTesting) -->
15+
<!-- EndBlock(customBuildingAndTesting) -->
16+
### Replacing a Remote Version of the Library with Local Version
17+
18+
If you want to test the library exposed in this repository in a project that uses it, you can
19+
add the following `replace` directive to that project's `go.mod` file:
3220

33-
### Building (Locally)
21+
```
22+
replace github.com/getoutreach/localizer => /path/to/local/version/localizer
23+
```
3424

35-
To produce binaries in the `./bin/` folder, run `make build`.
25+
**_Note_**: This library may have postfixed it's module path with a version, go check the first
26+
line of the `go.mod` file in this repository to see if that is the case. If that is the case,
27+
you will need to modify the first part of the replace directive (the part before the `=>`) with
28+
that postfixed path.
3629

37-
### Unit Testing
30+
### Linting and Unit Testing
3831

39-
You can run the tests with:
32+
You can run the the linters and unit tests with:
4033

4134
```bash
4235
make test
43-
```
44-
45-
46-
## Releasing
47-
48-
Making releases for this repository follows the process in the [Bootstrap](https://github.com/getoutreach/bootstrap/tree/master/README.md#semver) documentation.
36+
```

LICENSE

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
Apache License
23
Version 2.0, January 2004
34
http://www.apache.org/licenses/
@@ -198,4 +199,4 @@
198199
distributed under the License is distributed on an "AS IS" BASIS,
199200
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200201
See the License for the specific language governing permissions and
201-
limitations under the License.
202+
limitations under the License.

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
1+
12
# localizer
3+
[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white)](https://pkg.go.dev/github.com/getoutreach/localizer)
4+
[![Generated via Bootstrap](https://img.shields.io/badge/Outreach-Bootstrap-%235951ff)](https://github.com/getoutreach/bootstrap)
25

36
A no-frills local development approach for Kubernetes powered Developer Environments.
47

5-
## Why another CLI tool?
8+
## Contributing
9+
10+
Please read the [CONTRIBUTING.md](CONTRIBUTING.md) document for guidelines on developing and contributing changes.
611

12+
## High-level Overview
13+
14+
<!--- Block(overview) -->
715
Tools such as; Telepresence, Skaffold, and others all attempt to solve the problem of getting users
816
used to using Kubernetes. This is a pretty big task given that Kubernetes has a gigantic surface
917
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!
6775
## License
6876

6977
Apache-2.0
78+
79+
<!--- EndBlock(overview) -->

bootstrap.lock

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

service.yaml

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,37 @@
11
name: localizer
22
reportingTeam: fnd-dtss
3-
description: ""
3+
description: A no-frills local development approach for Kubernetes powered Developer Environments.
44
oss: true
55
slack: ""
66
library: true
77
commands:
88
- localizer
9+
circleAPIKey: ""
910
releaseType: ""
1011
deployTo:
1112
environments: []
1213
arguments:
14+
circleAPIKey: ""
1315
dependencies:
1416
optional: []
1517
required: []
16-
description: ""
18+
description: A no-frills local development approach for Kubernetes powered Developer Environments.
19+
opslevel:
20+
confluenceSpaceKey: DTSS
21+
designDocumentLink: ""
22+
oss: true
1723
reportingTeam: fnd-dtss
18-
type: []
24+
type:
25+
- library
1926
modules:
2027
- url: https://github.com/getoutreach/stencil-base
2128
version: ""
29+
opsLevel:
30+
serviceTier: 0
31+
lifecycle: ""
32+
confluenceSpaceKey: DTSS
33+
pagerDutyLink: ""
34+
datadogDashboards:
35+
mainLink: ""
36+
custom: []
37+
designDocumentLink: ""

0 commit comments

Comments
 (0)