Skip to content

Commit

Permalink
Merge branch 'main' into updateWorkingWithPlugins
Browse files Browse the repository at this point in the history
  • Loading branch information
schristoff authored Mar 21, 2024
2 parents 9ab8491 + 90e731c commit 12ed361
Show file tree
Hide file tree
Showing 163 changed files with 338 additions and 341 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/design_proposal.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,5 @@ Provide other approaches considered prior to deciding on the submitted proposal.
If applicable, provide potential implementation details assuming the proposal is accepted.

# Checklist
- [ ] An announcement of this proposal has been sent to the Porter mailing list: https://getporter.org/mailing-list
- [ ] An announcement of this proposal has been sent to the Porter mailing list: https://porter.sh/mailing-list
- [ ] This proposal has remained open for at least one week, to allow time for community feedback.
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Closes # _(issue)_

_If there is not an existing issue, please make sure we have context on why this change is needed. See our Contributing Guide for [examples of when an existing issue isn't necessary][1]._

[1]: https://getporter.org/src/CONTRIBUTING.md#when-to-open-a-pull-request
[1]: https://porter.sh/src/CONTRIBUTING.md#when-to-open-a-pull-request

# Notes for the reviewer
_Put any questions or notes for the reviewer here._
Expand All @@ -23,4 +23,4 @@ _Put any questions or notes for the reviewer here._
* Comment with /azp run test-porter-release if a magefile or build script was modified
* Comment with /azp run porter-integration if it's a non-trivial PR

[contributors]: https://getporter.org/src/CONTRIBUTORS.md
[contributors]: https://porter.sh/src/CONTRIBUTORS.md
4 changes: 2 additions & 2 deletions .github/workflows/atom-template.xml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<feed xmlns="http://www.w3.org/2005/Atom">
<id>https://getporter.org/mixins</id>
<id>https://porter.sh/mixins</id>
<title>Porter Mixins</title>
<updated>{{Updated}}</updated>
<link rel="self" href="https://cdn.porter.sh/mixins/atom.xml"/>
<author>
<name>Porter Authors</name>
<uri>https://getporter.org/mixins</uri>
<uri>https://porter.sh/mixins</uri>
</author>
{{#Mixins}}
<category term="{{.}}"/>
Expand Down
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,4 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], versi
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org
[slack]: https://getporter.org/community#slack
[slack]: https://porter.sh/community#slack
48 changes: 24 additions & 24 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,19 +39,19 @@ how things will go.
If this is your first contribution to Porter, we have a [tutorial] that walks you
through how to setup your developer environment, make a change and test it.

[tutorial]: https://getporter.org/docs/contribute/tutorial/
[tutorial]: https://porter.sh/docs/contribute/tutorial/

## Code of Conduct

The Porter community is governed by our [Code of Conduct][coc].
This includes but isn't limited to: the porter and related mixin repositories,
slack, interactions on social media, project meetings, conferences and meetups.

[coc]: https://getporter.org/src/CODE_OF_CONDUCT.md
[coc]: https://porter.sh/src/CODE_OF_CONDUCT.md

## Find an issue

Use the [getporter.org/find-issue] link to find good first issues for new contributors and help wanted issues for our other contributors.
Use the [porter.sh/find-issue] link to find good first issues for new contributors and help wanted issues for our other contributors.

When you have been contributing for a while, take a look at the "Backlog" column on our [project board][board] for high priority issues.
The project board is at the organization level, so it contains issues from across all the Porter repositories.
Expand All @@ -78,16 +78,16 @@ Another great way to contribute is to create a mixin! You can start using the
When you create your first pull request, add your name to the bottom of our
[Contributors][contributors] list. Thank you for making Porter better! 🙇‍♀️

[getporter.org/find-issue]: https://getporter.org/find-issue/
[contributors]: https://getporter.org/src/CONTRIBUTORS.md
[porter.sh/find-issue]: https://porter.sh/find-issue/
[contributors]: https://porter.sh/src/CONTRIBUTORS.md
[skeletor]: https://github.com/getporter/skeletor
[mixin-dev-guide]: https://getporter.org/mixin-dev-guide/
[good-first-issue]: https://getporter.org/board/good+first+issue
[help-wanted]: https://getporter.org/board/help+wanted
[board]: https://getporter.org/board
[slack]: https://getporter.org/community#slack
[roadmap]: https://getporter.org/src/README.md#roadmap
[pep]: https://getporter.org/docs/contribute/proposals/
[mixin-dev-guide]: https://porter.sh/mixin-dev-guide/
[good-first-issue]: https://porter.sh/board/good+first+issue
[help-wanted]: https://porter.sh/board/help+wanted
[board]: https://porter.sh/board
[slack]: https://porter.sh/community#slack
[roadmap]: https://porter.sh/src/README.md#roadmap
[pep]: https://porter.sh/docs/contribute/proposals/

## Which branch to use

Expand Down Expand Up @@ -233,7 +233,7 @@ Porter! After your first pull request is merged, you will be invited to the
[Contributors team] which you may choose to accept (or not). Joining the team lets
you have issues in GitHub assigned to you.

[canary]: https://getporter.org/install/#canary
[canary]: https://porter.sh/install/#canary
[Contributors team]: https://github.com/orgs/getporter/teams/contributors

### Follow-on PR
Expand All @@ -258,7 +258,7 @@ Our [contribution ladder][ladder] defines the roles and responsibilities for thi
project and how to participate with the goal of moving from a user to a
maintainer.

[ladder]: https://getporter.org/src/CONTRIBUTION_LADDER.md
[ladder]: https://porter.sh/src/CONTRIBUTION_LADDER.md

# Developer Tasks

Expand Down Expand Up @@ -387,7 +387,7 @@ installed into your bin directory in the root of the repository. You can use

## Plugin Debugging

If you are developing a [plugin](https://getporter.org/plugins/) and you want to
If you are developing a [plugin](https://porter.sh/plugins/) and you want to
debug it follow these steps:

The plugin to be debugged should be compiled and placed in porters plugin path
Expand Down Expand Up @@ -435,7 +435,7 @@ a new blog post and then preview it:
1. Go to /docs/content/blog and create a new file. Whatever you name the file
will be the last part of the URL. For example a file named
"porter-collaboration.md" will be located at
<https://getporter.org/blog/porter-collaboration/>.
<https://porter.sh/blog/porter-collaboration/>.

1. At the top of the file copy and paste the frontmatter template below. The
frontmatter is YAML that instucts the blogging software, Hugo, how to render the
Expand Down Expand Up @@ -498,7 +498,7 @@ On the Jaeger dashboard, select "porter" from the service drop down, and click "

The smoke and integration tests will run with telemetry enabled when the PORTER_TEST_TELEMETRY_ENABLED environment variable is true.

[otel-jaeger bundle]: https://getporter.org/examples/src/otel-jaeger
[otel-jaeger bundle]: https://porter.sh/examples/src/otel-jaeger

## Debug Smoke Tests

Expand All @@ -522,7 +522,7 @@ If you are using GoLand, use the **Go Remote** debug configuration and make sure

## Command Documentation

Our commands are documented at <https://getporter.org/cli> and that documentation is
Our commands are documented at <https://porter.sh/cli> and that documentation is
generated by our CLI. You should regenerate that documentation when you change
any files in **cmd/porter** by running `mage DocsGen` which is run every time
you run `mage build`.
Expand Down Expand Up @@ -593,7 +593,7 @@ dependency injection and testing strategies.
* **templates**: files that need to be compiled into the porter binary with
version command.
* **scripts**:
* **install**: Porter [installation](https://getporter.org/install) scripts
* **install**: Porter [installation](https://porter.sh/install) scripts
* **tests** have Go-based integration tests.

## Logging
Expand Down Expand Up @@ -656,8 +656,8 @@ When you realize that you may need to make a breaking change, discuss it with a
Here are some examples of breaking changes:

* The schema of porter.yaml changed.
* The schema of Porter's [file formats](https://getporter.org/references/file-formats) changed.
* The schema of Porter's [config file](https://getporter.org/configuration/#config-file) changed.
* The schema of Porter's [file formats](https://porter.sh/references/file-formats) changed.
* The schema of Porter's [config file](https://porter.sh/configuration/#config-file) changed.
* Flags or behavior of a CLI command changed, such as removing a flag or adding a validation that can result in a hard error, preventing the command from running.

All of Porter's documents have a schemaVersion field and when the schema of the document is changed, the version number should be incremented as well in the default set on new documents, the supported schema version constant in the code, and in the documentation for that document.
Expand All @@ -683,6 +683,6 @@ See the [Custom Windows CI Agent] documentation for details on how the agent is
Our [version strategy] explains how we version the project, when you should expect
breaking changes in a release, and the process for the v1 release.

[cdn]: https://getporter.org/src/infra/cdn.md
[version strategy]: https://getporter.org/references/version-strategy/
[Custom Windows CI Agent]: https://getporter.org/src/infra/custom-windows-ci-agent.md
[cdn]: https://porter.sh/src/infra/cdn.md
[version strategy]: https://porter.sh/references/version-strategy/
[Custom Windows CI Agent]: https://porter.sh/src/infra/custom-windows-ci-agent.md
2 changes: 1 addition & 1 deletion CONTRIBUTION_LADDER.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Here are some ideas for how you can be more involved and participate in the comm

They must follow our [Code of Conduct](CODE_OF_CONDUCT.md).

[slack]: https://getporter.org/community#slack
[slack]: https://porter.sh/community#slack

## Contributor

Expand Down
52 changes: 26 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,45 +2,45 @@

[![CNCF Sandbox Project](docs/static/images/cncf-sandbox-badge.svg)](https://www.cncf.io/projects/porter/)
[![porter](https://github.com/getporter/porter/actions/workflows/porter.yml/badge.svg?branch=main&event=push)](https://github.com/getporter/porter/actions/workflows/porter.yml)
<a href="https://getporter.org/find-issue" alt="Find an issue to work on">
<a href="https://porter.sh/find-issue" alt="Find an issue to work on">
<img src="https://img.shields.io/github/issues-search?label=%22help%20wanted%22%20issues&query=org%3Agetporter%20label%3A%22good%20first%20issue%22%2C%22help%20wanted%22%20no%3Aassignee" /></a>

# Porter

Package your application, client tools, configuration, and deployment logic into an installer that you can distribute and run with a single command.
Based on the Cloud Native Application Bundle Specification, [CNAB](https://deislabs.io/cnab), Porter provides a declarative authoring experience that lets you focus on what you know best: your application.

<p align="center">Learn all about Porter at <a href="https://getporter.org">getporter.org</a></p>
<p align="center">Learn all about Porter at <a href="https://porter.sh">porter.sh</a></p>

# <a name="mixins"></a>Porter Mixins

Mixins provide out-of-the-box support for interacting with different tools and services from inside a bundle. You can always create a mixin, or use the exec mixin and a Custom Dockerfile if a custom mixin doesn't exist yet.

[Porter Mixins](https://getporter.org/mixins/) are available for below platform's:
[Porter Mixins](https://porter.sh/mixins/) are available for below platform's:

| Platform | Supported? |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------: |
| <img src="docs\static\images\mixins\docker_icon.png" width="20" height="20" vertical-align="middle" /> [Docker](https://getporter.org/mixins/docker/) | ✔️ |
| <img src="docs\static\images\mixins\docker-compose.png" width="20" height="20" vertical-align="middle" /> [Docker-Compose](https://getporter.org/mixins/docker-compose/) | ✔️ |
| <img src="docs\static\images\mixins\kubernetes.svg" width="20" height="20" vertical-align="middle" /> [Kubernetes](https://getporter.org/mixins/kubernetes/) | ✔️ |
| <img src="docs\static\images\mixins\helm.svg" width="20" height="20" vertical-align="middle" /> [Helm](https://getporter.org/mixins/helm/) | ✔️ |
| <img src="docs\static\images\mixins\gcp.png" width="20" height="20" vertical-align="middle" /> [GCloud](https://getporter.org/mixins/gcloud/) | ✔️ |
| <img src="docs\static\images\mixins\terraform_icon.png" width="20" height="20" vertical-align="middle" /> [Terraform](https://getporter.org/mixins/terraform/) | ✔️ |
| <img src="docs\static\images\mixins\aws.svg" width="20" height="20" vertical-align="middle" /> [aws](https://getporter.org/mixins/aws/) | ✔️ |
| <img src="docs\static\images\plugins\azure.png" width="20" height="20" vertical-align="middle" /> [Azure](https://getporter.org/mixins/azure/) | ✔️ |
| <img src="docs\static\images\mixins\exec.png" width="20" height="20" vertical-align="middle" /> [exec](https://getporter.org/mixins/exec/) | ✔️ |
| <img src="docs\static\images\mixins\docker_icon.png" width="20" height="20" vertical-align="middle" /> [Docker](https://porter.sh/mixins/docker/) | ✔️ |
| <img src="docs\static\images\mixins\docker-compose.png" width="20" height="20" vertical-align="middle" /> [Docker-Compose](https://porter.sh/mixins/docker-compose/) | ✔️ |
| <img src="docs\static\images\mixins\kubernetes.svg" width="20" height="20" vertical-align="middle" /> [Kubernetes](https://porter.sh/mixins/kubernetes/) | ✔️ |
| <img src="docs\static\images\mixins\helm.svg" width="20" height="20" vertical-align="middle" /> [Helm](https://porter.sh/mixins/helm/) | ✔️ |
| <img src="docs\static\images\mixins\gcp.png" width="20" height="20" vertical-align="middle" /> [GCloud](https://porter.sh/mixins/gcloud/) | ✔️ |
| <img src="docs\static\images\mixins\terraform_icon.png" width="20" height="20" vertical-align="middle" /> [Terraform](https://porter.sh/mixins/terraform/) | ✔️ |
| <img src="docs\static\images\mixins\aws.svg" width="20" height="20" vertical-align="middle" /> [aws](https://porter.sh/mixins/aws/) | ✔️ |
| <img src="docs\static\images\plugins\azure.png" width="20" height="20" vertical-align="middle" /> [Azure](https://porter.sh/mixins/azure/) | ✔️ |
| <img src="docs\static\images\mixins\exec.png" width="20" height="20" vertical-align="middle" /> [exec](https://porter.sh/mixins/exec/) | ✔️ |

# <a name="Plugins"></a>Porter Plugins

Plugins let you store Porter's data and retrieve secrets from an external service.

[Porter Plugins](https://getporter.org/plugins/) are available for below platform's:
[Porter Plugins](https://porter.sh/plugins/) are available for below platform's:

| Platform | Supported? |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------: |
| <img src="docs\static\images\plugins\hashicorp.png" width="20" height="20" vertical-align="middle" /> [Hashicorp](https://getporter.org/plugins/hashicorp/) | ✔️ |
| <img src="docs\static\images\plugins\azure.png" width="20" height="20" vertical-align="middle" /> [Azure](https://getporter.org/plugins/azure/) | ✔️ |
| <img src="docs\static\images\mixins\kubernetes.svg" width="20" height="20" vertical-align="middle" /> [Kubernetes](https://getporter.org/plugins/kubernetes/) | ✔️ |
| <img src="docs\static\images\plugins\hashicorp.png" width="20" height="20" vertical-align="middle" /> [Hashicorp](https://porter.sh/plugins/hashicorp/) | ✔️ |
| <img src="docs\static\images\plugins\azure.png" width="20" height="20" vertical-align="middle" /> [Azure](https://porter.sh/plugins/azure/) | ✔️ |
| <img src="docs\static\images\mixins\kubernetes.svg" width="20" height="20" vertical-align="middle" /> [Kubernetes](https://porter.sh/plugins/kubernetes/) | ✔️ |


# Contact
Expand All @@ -55,20 +55,20 @@ Plugins let you store Porter's data and retrieve secrets from an external servic
* [Slack] - We have a #porter channel and there's also #cnab for deep thoughts
about the CNAB specification.

[Mailing List]: https://getporter.org/mailing-list
[Slack]: https://getporter.org/community/#slack
[Mailing List]: https://porter.sh/mailing-list
[Slack]: https://porter.sh/community/#slack
[Open an Issue]: https://github.com/getporter/porter/issues/new/choose
[Forum]: https://getporter.org/forum/
[Dev Meeting]: https://getporter.org/community/#dev-meeting
[Porter Enhancement Proposals]: https://getporter.org/docs/contribute/proposals/
[Forum]: https://porter.sh/forum/
[Dev Meeting]: https://porter.sh/community/#dev-meeting
[Porter Enhancement Proposals]: https://porter.sh/docs/contribute/proposals/

# Looking for Contributors

Want to work on Porter with us? 💖 We are actively seeking out new contributors
with the hopes of building up both casual contributors and enticing some of you
into becoming reviewers and maintainers.

<p align="center">Start with our <a href="https://getporter.org/docs/contribute/">New Contributors Guide</a>
<p align="center">Start with our <a href="https://porter.sh/docs/contribute/">New Contributors Guide</a>

Porter wouldn't be possible without our [contributors][contributors], carrying
the load and making it better every day! 🙇‍♀️
Expand All @@ -77,7 +77,7 @@ the load and making it better every day! 🙇‍♀️

# Do you use Porter?

Take our [user survey](https://getporter.org/user-survey) and let us know if you are using Porter.
Take our [user survey](https://porter.sh/user-survey) and let us know if you are using Porter.
Project funding is contingent upon knowing that we have active users!

# Roadmap
Expand All @@ -93,7 +93,7 @@ currently working on and plan to work on over the next few months. We use the
"on-hold" bucket to communicate items of interest that do not have a
maintainer who will be working on them.

<p align="center">Check out our <a href="https://getporter.org/roadmap">roadmap</a></p>
<p align="center">Check out our <a href="https://porter.sh/roadmap">roadmap</a></p>

[board]: https://getporter.org/board
[version strategy]: https://getporter.org/project/version-strategy/
[board]: https://porter.sh/board
[version strategy]: https://porter.sh/project/version-strategy/
Loading

0 comments on commit 12ed361

Please sign in to comment.