Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change org and repository name in 0.44.x line #800

Merged
merged 4 commits into from
Jan 27, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/add-to-project.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ jobs:
steps:
- uses: actions/[email protected]
with:
project-url: https://github.com/orgs/vmware-tanzu/projects/16
project-url: https://github.com/orgs/carvel-dev/projects/1
github-token: ${{ secrets.CARVEL_ADD_TO_PROJECT_TOKEN }}
4 changes: 2 additions & 2 deletions .github/workflows/release-published.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ jobs:
validate-github-action:
runs-on: ubuntu-latest
steps:
- uses: vmware-tanzu/carvel-setup-action@v1
- uses: carvel-dev/setup-action@v1
with:
only: ytt
ytt: ${{ github.event.release.tag_name }}
Expand All @@ -25,7 +25,7 @@ jobs:
exit 1
fi
- run: |
curl -X POST https://api.github.com/repos/vmware-tanzu/carvel-release-scripts/dispatches \
curl -X POST https://api.github.com/repos/carvel-dev/release-scripts/dispatches \
-H 'Accept: application/vnd.github.everest-preview+json' \
-u ${{ secrets.carvel_bot_access_token }} \
--data '{"event_type": "ytt_released", "client_payload": { "tagName": "${{ github.event.release.tag_name }}", "repo": "${{ github.repository }}", "toolName": "ytt" }}'
4 changes: 2 additions & 2 deletions .github/workflows/trivy-scan.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ on:

jobs:
trivy-scan:
uses: vmware-tanzu/carvel-release-scripts/.github/workflows/trivy-scan.yml@main
uses: carvel-dev/release-scripts/.github/workflows/trivy-scan.yml@main
with:
repo: vmware-tanzu/carvel-ytt
repo: carvel-dev/ytt
tool: ytt
goVersion: "1.19.5"
secrets:
Expand Down
6 changes: 3 additions & 3 deletions .goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ builds:
- -trimpath

ldflags:
- -X github.com/vmware-tanzu/carvel-ytt/pkg/version.Version={{ .Version }}
- -X github.com/carvel-dev/ytt/pkg/version.Version={{ .Version }}
vmunishwar marked this conversation as resolved.
Show resolved Hide resolved

archives:
- format: binary
Expand All @@ -39,8 +39,8 @@ snapshot:
release:
# Repo in which the release will be created.
github:
owner: vmware-tanzu
name: carvel-ytt
owner: carvel-dev
name: ytt

# If set to true, will not auto-publish the release.
draft: true
Expand Down
2 changes: 1 addition & 1 deletion GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# ytt Governance
ytt governance can be found within the main [Carvel GitHub repo](https://github.com/vmware-tanzu/carvel) within the [GOVERNANCE.md](https://github.com/vmware-tanzu/carvel/blob/develop/GOVERNANCE.md) file.
ytt governance can be found within the main [Carvel GitHub repo](https://github.com/carvel-dev/carvel) within the [GOVERNANCE.md](https://github.com/carvel-dev/carvel/blob/develop/GOVERNANCE.md) file.
2 changes: 1 addition & 1 deletion MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# ytt Maintainers
Maintainers for ytt can be found within the main [Carvel GitHub repo](https://github.com/vmware-tanzu/carvel) within the [MAINTAINERS.md](https://github.com/vmware-tanzu/carvel/blob/develop/MAINTAINERS.md) file.
Maintainers for ytt can be found within the main [Carvel GitHub repo](https://github.com/carvel-dev/carvel) within the [MAINTAINERS.md](https://github.com/carvel-dev/carvel/blob/develop/MAINTAINERS.md) file.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
* Discover `ytt` in [video](https://youtu.be/WJw1MDFMVuk)
* For more information about annotations, data values, overlays and other features see [Docs](https://carvel.dev/ytt/docs/latest/) page
* Slack: [#carvel in Kubernetes slack](https://slack.kubernetes.io/)
* Install: Grab prebuilt binaries from the [Releases page](https://github.com/vmware-tanzu/carvel-ytt/releases) or [Homebrew Carvel tap](https://github.com/vmware-tanzu/homebrew-carvel)
* Backlog: [See what we're up to]([https://app.zenhub.com/workspaces/carvel-backlog-6013063a24147d0011410709/board?repos=173207060). (Note: we use ZenHub which requires GitHub authorization](https://github.com/orgs/vmware-tanzu/projects/16/views/1?filterQuery=repo%3A%22vmware-tanzu%2Fcarvel-ytt%22)).
* Install: Grab prebuilt binaries from the [Releases page](https://github.com/carvel-dev/ytt/releases) or [Homebrew Carvel tap](https://github.com/carvel-dev/homebrew)
* Backlog: [See what we're up to]([https://app.zenhub.com/workspaces/carvel-backlog-6013063a24147d0011410709/board?repos=173207060). (Note: we use ZenHub which requires GitHub authorization](https://github.com/orgs/carvel-dev/projects/1/views/1?filterQuery=repo%3A%22vmware-tanzu%2Fcarvel-ytt%22)).
vmunishwar marked this conversation as resolved.
Show resolved Hide resolved

## Overview

Expand All @@ -24,16 +24,16 @@
To get started with `ytt` and to see examples, you use the online playground or download the binaries and run the playground locally.

- Try out the [online playground](https://carvel.dev/ytt/#playground)
- Download the latest binaries from the [releases page](https://github.com/vmware-tanzu/carvel-ytt/releases) and run the playground locally: `ytt website`
- See the examples used in the playground on the [examples](https://github.com/vmware-tanzu/carvel-ytt/tree/develop/examples/playground) page
- Download the latest binaries from the [releases page](https://github.com/carvel-dev/ytt/releases) and run the playground locally: `ytt website`
- See the examples used in the playground on the [examples](https://github.com/carvel-dev/ytt/tree/develop/examples/playground) page
- Editor Extensions: [vscode syntax highlighting](https://marketplace.visualstudio.com/items?itemName=ewrenn.vscode-ytt)

### Join the Community and Make Carvel Better
Carvel is better because of our contributors and maintainers. It is because of you that we can bring great software to the community. Please join us during our online community meetings. Details can be found on our [Carvel website](https://carvel.dev/community/).

You can chat with us on Kubernetes Slack in the #carvel channel and follow us on Twitter at @carvel_dev.

Check out which organizations are using and contributing to Carvel: [Adopter's list](https://github.com/vmware-tanzu/carvel/blob/master/ADOPTERS.md)
Check out which organizations are using and contributing to Carvel: [Adopter's list](https://github.com/carvel-dev/carvel/blob/master/ADOPTERS.md)

### Integrating with ytt

Expand Down
2 changes: 1 addition & 1 deletion ROADMAP.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# ytt Roadmap
The roadmap details for ytt can be found within the main [Carvel GitHub repo](https://github.com/vmware-tanzu/carvel) within the [ROADMAP.md](https://github.com/vmware-tanzu/carvel/blob/develop/ROADMAP.md) file.
The roadmap details for ytt can be found within the main [Carvel GitHub repo](https://github.com/carvel-dev/carvel) within the [ROADMAP.md](https://github.com/carvel-dev/carvel/blob/develop/ROADMAP.md) file.
32 changes: 16 additions & 16 deletions docs/dev.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
## Building

```bash
git clone https://github.com/vmware-tanzu/carvel-ytt ./src/github.com/vmware-tanzu/carvel-ytt
git clone https://github.com/carvel-dev/ytt ./src/github.com/carvel-dev/ytt
export GOPATH=$PWD
cd ./src/github.com/vmware-tanzu/carvel-ytt
cd ./src/github.com/carvel-dev/ytt

./hack/build.sh
./hack/test-unit.sh
Expand All @@ -12,30 +12,30 @@ cd ./src/github.com/vmware-tanzu/carvel-ytt
```

## Source Code Changes
To keep source code documentation up to date, ytt uses [godoc](https://go.dev/blog/godoc). To document a type, variable, constant, function, or a package, write a regular comment directly preceding its declaration that begins with the name of the element it describes. See the ["@ytt:ip" module](https://github.com/vmware-tanzu/carvel-ytt/blob/develop/pkg/yttlibrary/ip.go) for examples. When contributing new source code via a PR, the [GitHub Action linter](https://github.com/vmware-tanzu/carvel-ytt/blob/develop/.github/workflows/golangci-lint.yml) will ensure that godocs are included in the changes.
To keep source code documentation up to date, ytt uses [godoc](https://go.dev/blog/godoc). To document a type, variable, constant, function, or a package, write a regular comment directly preceding its declaration that begins with the name of the element it describes. See the ["@ytt:ip" module](https://github.com/carvel-dev/ytt/blob/develop/pkg/yttlibrary/ip.go) for examples. When contributing new source code via a PR, the [GitHub Action linter](https://github.com/carvel-dev/ytt/blob/develop/.github/workflows/golangci-lint.yml) will ensure that godocs are included in the changes.

To view the docs
1. install godoc: `go get -v golang.org/x/tools/cmd/godoc`
1. Start the server: `godoc -http=:6060` and visit [`http://localhost:6060/pkg/github.com/vmware-tanzu/carvel-ytt/`](http://localhost:6060/pkg/github.com/vmware-tanzu/carvel-ytt/).
1. Start the server: `godoc -http=:6060` and visit [`http://localhost:6060/pkg/github.com/carvel-dev/ytt/`](http://localhost:6060/pkg/github.com/carvel-dev/ytt/).
vmunishwar marked this conversation as resolved.
Show resolved Hide resolved

The go module was renamed from `github.com/k14s` to `github.com/vmware-tanzu/carvel-ytt` in February 2022. Carvel started out as a suite named "k14s" short for Kubernetes Tools.
The go module was renamed from `github.com/k14s` to `github.com/carvel-dev/ytt` in February 2022. Carvel started out as a suite named "k14s" short for Kubernetes Tools.
vmunishwar marked this conversation as resolved.
Show resolved Hide resolved

## Source Code Structure

For those interested in extending and improving `ytt`, below is a quick reference on the structure of the source code:

- [pkg/cmd/template/cmd.go](https://github.com/vmware-tanzu/carvel-ytt/blob/develop/pkg/cmd/template/cmd.go#L95) is the top level call site for the template command
- [pkg/files](https://github.com/vmware-tanzu/carvel-ytt/tree/develop/pkg/files) allows reading files from filesystem
- [pkg/workspace](https://github.com/vmware-tanzu/carvel-ytt/tree/develop/pkg/workspace) keeps read files from the filesystem in memory for later access
- [pkg/cmd/template/cmd.go](https://github.com/carvel-dev/ytt/blob/develop/pkg/cmd/template/cmd.go#L95) is the top level call site for the template command
- [pkg/files](https://github.com/carvel-dev/ytt/tree/develop/pkg/files) allows reading files from filesystem
- [pkg/workspace](https://github.com/carvel-dev/ytt/tree/develop/pkg/workspace) keeps read files from the filesystem in memory for later access
- `load(...)` directive goes through `TemplateLoader` to load files
- [pkg/yamlmeta](https://github.com/vmware-tanzu/carvel-ytt/tree/develop/pkg/yamlmeta) parses YAML and tracks YAML node annotations (metas)
- [pkg/yamltemplate](https://github.com/vmware-tanzu/carvel-ytt/tree/develop/pkg/yamltemplate) generates Starlark template based on yamlmeta package structures
- [pkg/texttemplate](https://github.com/vmware-tanzu/carvel-ytt/tree/develop/pkg/texttemplate) parses text templates and generates Starlark template
- [pkg/template](https://github.com/vmware-tanzu/carvel-ytt/tree/develop/pkg/template)
- [pkg/yamlmeta](https://github.com/carvel-dev/ytt/tree/develop/pkg/yamlmeta) parses YAML and tracks YAML node annotations (metas)
- [pkg/yamltemplate](https://github.com/carvel-dev/ytt/tree/develop/pkg/yamltemplate) generates Starlark template based on yamlmeta package structures
- [pkg/texttemplate](https://github.com/carvel-dev/ytt/tree/develop/pkg/texttemplate) parses text templates and generates Starlark template
- [pkg/template](https://github.com/carvel-dev/ytt/tree/develop/pkg/template)
- `InstructionSet` provides generic template instruction set for building Starlark templates
- `CompiledTemplate` uses [Starlark Go library](https://github.com/google/starlark-go) to evaluate Starlark code
- [pkg/yttlibrary](https://github.com/vmware-tanzu/carvel-ytt/tree/develop/pkg/yttlibrary) is bundled `@ytt` library
- you can also make your own libraries as exemplified by [vmware-tanzu/carvel-ytt-library-for-kubernetes](https://github.com/vmware-tanzu/carvel-ytt-library-for-kubernetes)
- [pkg/yttlibrary](https://github.com/carvel-dev/ytt/tree/develop/pkg/yttlibrary) is bundled `@ytt` library
- you can also make your own libraries as exemplified by [carvel-dev/ytt-library-for-kubernetes](https://github.com/carvel-dev/ytt-library-for-kubernetes)

### Tests

Expand Down Expand Up @@ -103,5 +103,5 @@ When contributing to this library note:
### Prior Efforts

For your convenience, here's a list of PRs of prior contributions to the standard library:
- [module for handling Internet Protocol data #433](https://github.com/vmware-tanzu/carvel-ytt/pull/433)
- [Add url type in the url module #372](https://github.com/vmware-tanzu/carvel-ytt/pull/372)
- [module for handling Internet Protocol data #433](https://github.com/carvel-dev/ytt/pull/433)
- [Add url type in the url module #372](https://github.com/carvel-dev/ytt/pull/372)
2 changes: 1 addition & 1 deletion hack/build-binaries.sh
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ VERSION="${1:-`get_latest_git_tag`}"

# makes builds reproducible
export CGO_ENABLED=0
LDFLAGS="-X github.com/vmware-tanzu/carvel-ytt/pkg/version.Version=$VERSION"
LDFLAGS="-X github.com/carvel-dev/ytt/pkg/version.Version=$VERSION"
vmunishwar marked this conversation as resolved.
Show resolved Hide resolved

./hack/build.sh $VERSION # Used to generate website/generated.go used by ytt website

Expand Down