Skip to content

Commit

Permalink
Merge branch 'main' into depParamsOverride
Browse files Browse the repository at this point in the history
Signed-off-by: Kim Christensen <[email protected]>
  • Loading branch information
kichristensen committed Mar 15, 2024
2 parents 980d813 + d539cd3 commit 0ca48dc
Show file tree
Hide file tree
Showing 13 changed files with 174 additions and 95 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/integ-reuseable-workflow.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ on:
type: string
default: ghcr.io
env:
GOVERSION: 1.20.7
GOVERSION: 1.21.3
PORTER_INTEG_FILE: ${{inputs.test_name}}.go

jobs:
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/porter-canary.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ on:
jobs:
build_pipelinesrelease_template:
name: build_pipelinesrelease_template
uses: './.github/workflows/build_pipelinesrelease_template.yml'
uses: ./.github/workflows/build_pipelinesrelease_template.yml
with:
registry: ghcr.io/getporter
shouldPublish: ${{inputs.shouldPublish}}
skipTests: ${{inputs.skipTests}}
shouldPublish: "${{inputs.shouldPublish}}"
skipTests: "${{inputs.skipTests}}"
6 changes: 3 additions & 3 deletions .github/workflows/porter-integration-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on:
- 'docs/**'

env:
GOVERSION: 1.20.7
GOVERSION: 1.21.3

jobs:
archive_integration_test:
Expand Down Expand Up @@ -117,7 +117,7 @@ jobs:
run: go run mage.go build
shell: bash
- name: Integration Test
env:
env:
PORTER_INTEG_FILE: uninstall_test.go
run: go run mage.go -v TestIntegration
run: go run mage.go -v TestIntegration
shell: bash
6 changes: 3 additions & 3 deletions .github/workflows/porter-integration-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
default: ghcr.io

env:
GOVERSION: 1.20.7
GOVERSION: 1.21.3

jobs:
archive_integration_test:
Expand Down Expand Up @@ -138,7 +138,7 @@ jobs:
run: go run mage.go build
shell: bash
- name: Integration Test
env:
env:
PORTER_INTEG_FILE: uninstall_test.go
run: go run mage.go -v TestIntegration
run: go run mage.go -v TestIntegration
shell: bash
7 changes: 5 additions & 2 deletions .github/workflows/porter.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
name: porter/porter
name: porter
on:
push:
branches:
- main
pull_request:
branches:
- main
paths-ignore:
- 'docs/**'
env:
GOVERSION: 1.20.7
GOVERSION: 1.21.3

jobs:
Build:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<img align="right" src="docs/static/images/porter-docs-header.svg" width="300px" />

[![CNCF Sandbox Project](docs/static/images/cncf-sandbox-badge.svg)](https://www.cncf.io/projects/porter/)
[![Build Status](https://github.com/getporter/porter/actions/workflows/porter.yml/badge.svg)](https://github.com/getporter/porter/actions/workflows/porter.yml)
[![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">
<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>

Expand Down
40 changes: 20 additions & 20 deletions docs/content/docs/getting-started/install-porter.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ aliases:
- [Customize the Installation Script](#install-script-parameters)
- [Configure Command Completion](#command-completion)

# Install or Upgrade
## Install or Upgrade

The examples below use a hard-coded version of Porter. There may be a newer version available which you can check for on our [release] page.
Set VERSION to the most recent [release] version number.
Expand All @@ -46,7 +46,7 @@ $VERSION="v1.0.14"
.\install-porter.ps1
```

## Running multiple versions
### Running multiple versions

If you have multiple versions of Porter installed on the same machine, you can switch between then by setting the PORTER_HOME environment variable and adding the desired version of Porter to your PATH.

Expand All @@ -73,7 +73,7 @@ porter version
[mailing list]: https://groups.io/g/porter
[Slack]: /community/#slack

# Clean Install
## Clean Install

To perform a clean installation of Porter:

Expand All @@ -90,59 +90,59 @@ To perform a clean installation of Porter:

3. Install Porter following the instructions on this page.

# Latest
## Latest

Install the most recent tagged v1 release of porter and the [exec mixin].

## Latest MacOS
### Latest MacOS

```
curl -L https://cdn.porter.sh/latest/install-mac.sh | bash
```

## Latest Linux
### Latest Linux

```
curl -L https://cdn.porter.sh/latest/install-linux.sh | bash
```

## Latest Windows
### Latest Windows

You will need to create a [PowerShell Profile][ps-link] if you do not have one.

```
iwr "https://cdn.porter.sh/latest/install-windows.ps1" -UseBasicParsing | iex
```

# Canary
## Canary

Install the most recent build of Porter and the [exec mixin] from the main branch.

This saves you the trouble of cloning and building porter and its mixin
repositories yourself. The build may not be stable, but it will have new features
that we are developing.

## Canary MacOS
### Canary MacOS

```
curl -L https://cdn.porter.sh/canary/install-mac.sh | bash
```

## Canary Linux
### Canary Linux

```
curl -L https://cdn.porter.sh/canary/install-linux.sh | bash
```

## Canary Windows
### Canary Windows

You will need to create a [PowerShell Profile][ps-link] if you do not have one.

```
iwr "https://cdn.porter.sh/canary/install-windows.ps1" -UseBasicParsing | iex
```

# Mixins
## Mixins

We have a number of [mixins](/mixins) to help you get started.
Only the [exec mixin] is installed with Porter v1.0.0+, other mixins should be installed separately.
Expand All @@ -157,7 +157,7 @@ installed terraform mixin v1.0.0-rc.1 (090064b)

All the Porter-authored mixins are published to `https://cdn.porter.sh/mixins/atom.xml`.

# Plugins
## Plugins

We have a couple [plugins](/plugins) which extend Porter and integrate with other cloud providers and software.

Expand All @@ -173,11 +173,11 @@ All the Porter-authored plugins are published to `https://cdn.porter.sh/plugins/

[releases]: https://github.com/getporter/porter/releases

# Install Script Parameters
## Install Script Parameters

The installation scripts provide the following parameters. Parameters can be specified with environment variables for the macOS and Linux scripts, and on Windows they are named parameters in the script.

## PORTER_HOME
### PORTER_HOME

Location where Porter is installed (defaults to ~/.porter).

Expand All @@ -195,7 +195,7 @@ iwr REPLACE_WITH_INSTALL_URL -OutFile install-porter.ps1 -UseBasicParsing
.\install-porter.ps1 -PORTER_HOME C:\alt\porter\home
```

## PORTER_MIRROR
### PORTER_MIRROR

Base URL where Porter assets, such as binaries and atom feeds, are downloaded.
This lets you set up an internal mirror. Note that atom feeds and index files
Expand All @@ -216,7 +216,7 @@ iwr REPLACE_WITH_INSTALL_URL -OutFile install-porter.ps1 -UseBasicParsing
.\install-porter.ps1 -PORTER_MIRROR https://example.com/porter
```

### URL Structure
#### URL Structure

Configuring a mirror of Porter's assets is out of scope of this document.
Reach out on the Porter [mailing list] for assistance.
Expand All @@ -239,7 +239,7 @@ plugins/
- PLUGIN/PERMALINK/PLUGIN-GOOS-GOARCH[FILE_EXT]
```

# Command Completion
## Command Completion

Porter provides autocompletion support for Bash, Fish, Zsh, and PowerShell.

Expand All @@ -250,7 +250,7 @@ Porter provides autocompletion support for Bash, Fish, Zsh, and PowerShell.
[here]: https://kubernetes.io/docs/tasks/tools/install-kubectl-macos/#enable-shell-autocompletion

### Initial Setup
#### Initial Setup

The initial setup is to generate a completion script file and have your shell environment source it when you start your shell.

Expand All @@ -264,7 +264,7 @@ porter completion bash > /usr/local/etc/bash_completion.d/porter

Once your completion script file is in place you will have to source it for your current shell or start a new shell session.

### Completion Usage
#### Completion Usage

To list available commands for Porter, in your terminal run

Expand Down
35 changes: 19 additions & 16 deletions go.mod
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
module get.porter.sh/porter

go 1.20
go 1.21

toolchain go1.21.3

replace (
// See https://github.com/hashicorp/go-plugin/pull/127 and
Expand All @@ -11,10 +13,11 @@ replace (

// Fixes https://github.com/spf13/viper/issues/761
github.com/spf13/viper => github.com/getporter/viper v1.7.1-porter.2.0.20210514172839-3ea827168363

)

require (
get.porter.sh/magefiles v0.6.1
get.porter.sh/magefiles v0.6.2
github.com/Masterminds/semver/v3 v3.2.1
github.com/PaesslerAG/jsonpath v0.1.1
github.com/carolynvs/aferox v0.3.0
Expand All @@ -32,7 +35,7 @@ require (
github.com/docker/docker v24.0.5-0.20230714235725-36e9e796c6fc+incompatible
github.com/dustin/go-humanize v1.0.1
github.com/ghodss/yaml v1.0.0
github.com/google/go-cmp v0.5.9
github.com/google/go-cmp v0.6.0
github.com/google/go-containerregistry v0.19.0
github.com/google/uuid v1.3.1
github.com/grpc-ecosystem/go-grpc-middleware v1.4.0
Expand Down Expand Up @@ -71,13 +74,13 @@ require (
go.opentelemetry.io/otel/sdk v1.19.0
go.opentelemetry.io/otel/trace v1.19.0
go.uber.org/zap v1.24.0
golang.org/x/sync v0.3.0
golang.org/x/sync v0.5.0
google.golang.org/grpc v1.59.0
google.golang.org/protobuf v1.31.0
gopkg.in/AlecAivazis/survey.v1 v1.8.8
gopkg.in/op/go-logging.v1 v1.0.0-20160211212156-b2cb9fa56473
gopkg.in/yaml.v3 v3.0.1
k8s.io/utils v0.0.0-20230505201702-9f6742963106
k8s.io/utils v0.0.0-20230726121419-3b25d923346b
)

require (
Expand Down Expand Up @@ -120,12 +123,12 @@ require (
github.com/docker/go-metrics v0.0.1 // indirect
github.com/docker/go-units v0.5.0 // indirect
github.com/dsnet/compress v0.0.2-0.20210315054119-f66993602bf5 // indirect
github.com/emicklei/go-restful/v3 v3.10.2 // indirect
github.com/emicklei/go-restful/v3 v3.11.0 // indirect
github.com/fatih/color v1.15.0 // indirect
github.com/felixge/httpsnoop v1.0.3 // indirect
github.com/fsnotify/fsnotify v1.6.0 // indirect
github.com/fvbommel/sortorder v1.1.0 // indirect
github.com/go-logr/logr v1.2.4 // indirect
github.com/go-logr/logr v1.3.0 // indirect
github.com/go-logr/stdr v1.2.2 // indirect
github.com/go-openapi/jsonpointer v0.19.6 // indirect
github.com/go-openapi/jsonreference v0.20.2 // indirect
Expand Down Expand Up @@ -227,14 +230,14 @@ require (
go.uber.org/atomic v1.11.0 // indirect
go.uber.org/multierr v1.11.0 // indirect
golang.org/x/crypto v0.17.0 // indirect
golang.org/x/mod v0.12.0 // indirect
golang.org/x/net v0.17.0 // indirect
golang.org/x/mod v0.14.0 // indirect
golang.org/x/net v0.19.0 // indirect
golang.org/x/oauth2 v0.12.0 // indirect
golang.org/x/sys v0.15.0 // indirect
golang.org/x/term v0.15.0 // indirect
golang.org/x/text v0.14.0 // indirect
golang.org/x/time v0.3.0 // indirect
golang.org/x/tools v0.11.1 // indirect
golang.org/x/tools v0.16.1 // indirect
golang.org/x/xerrors v0.0.0-20220907171357-04be3eba64a2 // indirect
google.golang.org/appengine v1.6.7 // indirect
google.golang.org/genproto v0.0.0-20231012201019-e917dd12ba7a // indirect
Expand All @@ -243,13 +246,13 @@ require (
gopkg.in/inf.v0 v0.9.1 // indirect
gopkg.in/ini.v1 v1.67.0 // indirect
gopkg.in/yaml.v2 v2.4.0 // indirect
k8s.io/api v0.28.0-alpha.3 // indirect
k8s.io/apimachinery v0.28.0-alpha.3 // indirect
k8s.io/client-go v0.28.0-alpha.3 // indirect
k8s.io/klog/v2 v2.100.1 // indirect
k8s.io/kube-openapi v0.0.0-20230614213217-ba0abe644833 // indirect
k8s.io/api v0.29.1 // indirect
k8s.io/apimachinery v0.29.1 // indirect
k8s.io/client-go v0.29.1 // indirect
k8s.io/klog/v2 v2.110.1 // indirect
k8s.io/kube-openapi v0.0.0-20231010175941-2dd684a91f00 // indirect
sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
sigs.k8s.io/structured-merge-diff/v4 v4.2.3 // indirect
sigs.k8s.io/structured-merge-diff/v4 v4.4.1 // indirect
sigs.k8s.io/yaml v1.3.0 // indirect
)

Expand Down
Loading

0 comments on commit 0ca48dc

Please sign in to comment.