Skip to content

Commit

Permalink
build: rename master branch to main branch (#12149)
Browse files Browse the repository at this point in the history
Signed-off-by: Anton Gilgur <[email protected]>
Signed-off-by: Saravanan Balasubramanian <[email protected]>
  • Loading branch information
agilgur5 authored and sarabala1979 committed Jan 10, 2024
1 parent a923d7f commit 5f68d8e
Show file tree
Hide file tree
Showing 63 changed files with 2,586 additions and 2,107 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ body:
required: true
- label: I can confirm the issues exists when I tested with `:latest`
required: true
- label: I'd like to contribute the fix myself (see [contributing guide](https://github.com/argoproj/argo-workflows/blob/master/docs/CONTRIBUTING.md))
- label: I'd like to contribute the fix myself (see [contributing guide](https://github.com/argoproj/argo-workflows/blob/main/docs/CONTRIBUTING.md))
- type: textarea
id: description
attributes:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/regression.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ body:
required: true
- label: I can confirm the issues exists when I tested with `:latest`
required: true
- label: I'd like to contribute the fix myself (see [contributing guide](https://github.com/argoproj/argo-workflows/blob/master/docs/CONTRIBUTING.md))
- label: I'd like to contribute the fix myself (see [contributing guide](https://github.com/argoproj/argo-workflows/blob/main/docs/CONTRIBUTING.md))
- type: textarea
id: description
attributes:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/changelog.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
steps:
- uses: actions/checkout@v4
with:
ref: master
ref: main
fetch-depth: 0
- run: git fetch --prune --prune-tags
- run: git tag -l 'v*'
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/ci-build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ name: CI
on:
push:
branches:
- "master"
- "main"
- "release-*"
- "!release-2.8"
pull_request:
branches:
- "master"
- "main"

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
Expand Down Expand Up @@ -118,7 +118,7 @@ jobs:
- run: make test STATIC_FILES=false GOTEST='go test -p 20 -covermode=atomic -coverprofile=coverage.out'
# engineers just ignore this in PRs, so lets not even run it
- name: Upload coverage report
if: github.ref == 'refs/heads/master'
if: github.ref == 'refs/heads/main'
run: bash <(curl -s https://codecov.io/bash)

argoexec-image:
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ name: Docs
on:
push:
branches:
- master
- main
pull_request:
branches:
- master
- main

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
Expand Down Expand Up @@ -42,8 +42,8 @@ jobs:
name: docs
path: site
if-no-files-found: error
- name: Publish to GH Pages (when on master)
if: github.repository == 'argoproj/argo-workflows' && github.ref == 'refs/heads/master'
- name: Publish to GH Pages (when on main)
if: github.repository == 'argoproj/argo-workflows' && github.ref == 'refs/heads/main'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
Expand Down
14 changes: 7 additions & 7 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ on:
tags:
- v*
branches:
- master
- main
- dev-*

concurrency:
Expand Down Expand Up @@ -69,7 +69,7 @@ jobs:
run: |
set -eux
tag=$(basename $GITHUB_REF)
if [ $tag = "master" ]; then
if [ $tag = "main" ]; then
tag="latest"
fi
# copied verbatim from Makefile
Expand Down Expand Up @@ -118,7 +118,7 @@ jobs:
docker_org=$DOCKERIO_ORG
tag=$(basename $GITHUB_REF)
if [ $tag = "master" ]; then
if [ $tag = "main" ]; then
tag="latest"
fi
Expand Down Expand Up @@ -177,7 +177,7 @@ jobs:
docker_org=$DOCKERIO_ORG
tag=$(basename $GITHUB_REF)
if [ $tag = "master" ]; then
if [ $tag = "main" ]; then
tag="latest"
fi
Expand Down Expand Up @@ -230,7 +230,7 @@ jobs:
TARGET: ${{ matrix.target }}
run: |
tag=$(basename $GITHUB_REF)
if [ $tag = "master" ]; then
if [ $tag = "main" ]; then
tag="latest"
fi
Expand Down Expand Up @@ -262,7 +262,7 @@ jobs:
run: |
docker_org=$DOCKERIO_ORG
tag=$(basename $GITHUB_REF)
if [ $tag = "master" ]; then
if [ $tag = "main" ]; then
tag="latest"
fi
Expand Down Expand Up @@ -302,7 +302,7 @@ jobs:
cosign-release: 'v1.13.0'
# https://stackoverflow.com/questions/58033366/how-to-get-current-branch-within-github-actions
- run: |
if [ ${GITHUB_REF##*/} = master ]; then
if [ ${GITHUB_REF##*/} = main ]; then
echo "VERSION=latest" >> $GITHUB_ENV
else
echo "VERSION=${GITHUB_REF##*/}" >> $GITHUB_ENV
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/snyk.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ on:
- cron: "30 2 * * *"
push:
branches:
- master
- main
- release-*

permissions:
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ GIT_BRANCH := $(shell git rev-parse --symbolic-full-name --verify --q
GIT_TAG := $(shell git describe --exact-match --tags --abbrev=0 2> /dev/null || echo untagged)
GIT_TREE_STATE := $(shell if [ -z "`git status --porcelain`" ]; then echo "clean" ; else echo "dirty"; fi)
RELEASE_TAG := $(shell if [[ "$(GIT_TAG)" =~ ^v[0-9]+\.[0-9]+\.[0-9]+.*$$ ]]; then echo "true"; else echo "false"; fi)
DEV_BRANCH := $(shell [ "$(GIT_BRANCH)" = master ] || [ `echo $(GIT_BRANCH) | cut -c -8` = release- ] || [ `echo $(GIT_BRANCH) | cut -c -4` = dev- ] || [ $(RELEASE_TAG) = true ] && echo false || echo true)
DEV_BRANCH := $(shell [ "$(GIT_BRANCH)" = main ] || [ `echo $(GIT_BRANCH) | cut -c -8` = release- ] || [ `echo $(GIT_BRANCH) | cut -c -4` = dev- ] || [ $(RELEASE_TAG) = true ] && echo false || echo true)
SRC := $(GOPATH)/src/github.com/argoproj/argo-workflows


Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ All vulnerabilities and associated information will be treated with full confide

## Public Disclosure

Security vulnerabilities will be disclosed via [release notes](https://github.com/argoproj/argo-workflows/blob/master/CHANGELOG.md) and using the
Security vulnerabilities will be disclosed via [release notes](CHANGELOG.md) and using the
[GitHub Security Advisories](https://github.com/argoproj/argo-workflows/security/advisories)
feature to keep our community well informed, and will credit you for your findings (unless you prefer to stay anonymous, of course).

Expand Down
2 changes: 1 addition & 1 deletion USERS.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Argo Workflows User Community Surveys & Feedback

User community survey results are available: [2023](https://blog.argoproj.io/argo-workflows-events-2023-user-survey-results-82c53bc30543), [2021](https://blog.argoproj.io/argo-workflows-2021-survey-results-d6fa890030ee?gi=857daaa1faa9), and [2020](https://github.com/argoproj/argoproj/blob/master/community/user_surveys/ArgoWorkflows2020SurveySummary.pdf).
User community survey results are available: [2023](https://blog.argoproj.io/argo-workflows-events-2023-user-survey-results-82c53bc30543), [2021](https://blog.argoproj.io/argo-workflows-2021-survey-results-d6fa890030ee?gi=857daaa1faa9), and [2020](https://github.com/argoproj/argoproj/blob/main/community/user_surveys/ArgoWorkflows2020SurveySummary.pdf).


## Who uses Argo Workflows?
Expand Down
2 changes: 1 addition & 1 deletion community/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

Welcome to the Argo community!

Argo is an open, community driven project to make it easy to use Kubernetes for getting useful work done. [This document](https://github.com/argoproj/argoproj/blob/master/community/README.md) describes the organizational structure of the Argo Community including the roles, responsibilities and processes that govern Argo projects and community.
Argo is an open, community driven project to make it easy to use Kubernetes for getting useful work done. [This document](https://github.com/argoproj/argoproj/blob/main/community/README.md) describes the organizational structure of the Argo Community including the roles, responsibilities and processes that govern Argo projects and community.
5 changes: 2 additions & 3 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,13 +65,12 @@ No, we should not add that dependency.
### Test Policy

Changes without either unit or e2e tests are unlikely to be accepted.
See [the pull request template](https://github.com/argoproj/argo-workflows/blob/master/.github/pull_request_template.md)
.
See [the pull request template](https://github.com/argoproj/argo-workflows/blob/main/.github/pull_request_template.md).

### Contributor Workshop

Please check out the following resources if you are interested in contributing:

* [90m hands-on contributor workshop](https://youtu.be/zZv0lNCDG9w).
* [Deep-dive into components and hands-on experiments](https://docs.google.com/presentation/d/1IU0a3unnr3tBRi38Zn3EHQZj3z6yvocfG9x9icRu1LE/edit?usp=sharing).
* [Architecture overview](https://github.com/argoproj/argo-workflows/blob/master/docs/architecture.md).
* [Architecture overview](https://github.com/argoproj/argo-workflows/blob/main/docs/architecture.md).
15 changes: 8 additions & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ Argo is a [Cloud Native Computing Foundation (CNCF)](https://cncf.io/) graduated

[Access the demo environment](https://workflows.apps.argoproj.io/workflows/argo) (login using Github)

![Screenshot](https://github.com/argoproj/argo-workflows/raw/master/docs/assets/screenshot.png)
![Screenshot](https://github.com/argoproj/argo-workflows/raw/main/docs/assets/screenshot.png)

## Who uses Argo Workflows?

[About 200+ organizations are officially using Argo Workflows](https://github.com/argoproj/argo-workflows/blob/master/USERS.md)
[About 200+ organizations are officially using Argo Workflows](https://github.com/argoproj/argo-workflows/blob/main/USERS.md)

## Ecosystem

Expand All @@ -64,16 +64,17 @@ Just some of the projects that use or rely on Argo Workflows (complete list [her

## Client Libraries

Check out our [Java, Golang and Python clients](https://github.com/argoproj/argo-workflows/blob/master/docs/client-libraries.md).
Check out our [Java, Golang and Python clients](client-libraries.md).

## Quickstart

* [Get started here](https://github.com/argoproj/argo-workflows/blob/master/docs/quick-start.md)
* [Walk-through examples](https://argo-workflows.readthedocs.io/en/release-3.5/walk-through/)
* [Get started here](quick-start.md)
* [Walk-through examples](walk-through/index.md)

## Documentation

[View the docs](https://argo-workflows.readthedocs.io/en/release-3.5/)
[View the docs](README.md)


## Features

Expand Down Expand Up @@ -150,4 +151,4 @@ the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-o

## Security

See [SECURITY.md](https://github.com/argoproj/argo-workflows/blob/master/SECURITY.md).
See [SECURITY.md](https://github.com/argoproj/argo-workflows/blob/main/SECURITY.md).
6 changes: 3 additions & 3 deletions docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The following diagram shows the components of the Argo Workflows architecture. There are two Deployments: Workflow Controller and Argo Server. The former does all of the reconciling, and the latter serves the API. Note that the Controller can be used stand alone.

The reconciliation code for the `WorkflowController` can be found in [`workflow/controller/controller.go`](https://github.com/argoproj/argo-workflows/blob/master/workflow/controller/controller.go). The Argo Server opens up an HTTP(S) listener at [`server/apiserver/argoserver.go`](https://github.com/argoproj/argo-workflows/blob/master/server/apiserver/argoserver.go).
The reconciliation code for the `WorkflowController` can be found in [`workflow/controller/controller.go`](https://github.com/argoproj/argo-workflows/blob/main/workflow/controller/controller.go). The Argo Server opens up an HTTP(S) listener at [`server/apiserver/argoserver.go`](https://github.com/argoproj/argo-workflows/blob/main/server/apiserver/argoserver.go).

![diagram](assets/diagram.png)

Expand All @@ -20,15 +20,15 @@ The internals of a Pod are also shown. Each Step and each DAG Task cause a Pod t
- `init` container is an `InitContainer`, fetching artifacts and parameters and making them available to the `main` container
- `wait` container performs tasks that are needed for clean up, including saving off parameters and artifacts

Look in [`cmd/argoexec`](https://github.com/argoproj/argo-workflows/blob/master/cmd/argoexec) for this code.
Look in [`cmd/argoexec`](https://github.com/argoproj/argo-workflows/blob/main/cmd/argoexec) for this code.

![diagram](assets/overview.jpeg)

---

## Workflow controller architecture

The following diagram shows the process for reconciliation, whereby a set of worker goroutines process the Workflows which have been added to a Workflow queue based on adds and updates to Workflows and Workflow Pods. Note that in addition to the Informers shown, there are Informers for the other CRDs that Argo Workflows uses as well. You can find this code in [`workflow/controller/controller.go`](https://github.com/argoproj/argo-workflows/blob/master/workflow/controller/controller.go). Note that the controller only ever processes a single Workflow at a time.
The following diagram shows the process for reconciliation, whereby a set of worker goroutines process the Workflows which have been added to a Workflow queue based on adds and updates to Workflows and Workflow Pods. Note that in addition to the Informers shown, there are Informers for the other CRDs that Argo Workflows uses as well. You can find this code in [`workflow/controller/controller.go`](https://github.com/argoproj/argo-workflows/blob/main/workflow/controller/controller.go). Note that the controller only ever processes a single Workflow at a time.

![diagram](assets/workflow-controller-queue.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/argo-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Use this mode if:
* You want a drop-in replacement for the Argo UI.
* If you need to prevent users from directly accessing the database.

Hosted mode is provided as part of the standard [manifests](https://github.com/argoproj/argo-workflows/blob/master/manifests), [specifically in argo-server-deployment.yaml](https://github.com/argoproj/argo-workflows/blob/master/manifests/base/argo-server/argo-server-deployment.yaml) .
Hosted mode is provided as part of the standard [manifests](https://github.com/argoproj/argo-workflows/blob/main/manifests), [specifically in `argo-server-deployment.yaml`](https://github.com/argoproj/argo-workflows/blob/main/manifests/base/argo-server/argo-server-deployment.yaml) .

## Local Mode

Expand Down
6 changes: 2 additions & 4 deletions docs/artifact-visualization.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Use cases:
* Visualizing end results of ML pipeline runs.
* Debugging workflows where visual artifacts are the most helpful.

[![Demo](assets/artifact-visualization-demo.png)](https://youtu.be/whoRfYY9Fhk)
[![Demo](assets/artifact-visualization-demo.png)](https://youtu.be/whoRfYY9Fhk)

* Artifacts appear as elements in the workflow DAG that you can click on.
* When you click on the artifact, a panel appears.
Expand All @@ -20,9 +20,7 @@ Use cases:
* Artifacts are sandboxed using a Content-Security-Policy that prevents JavaScript execution.
* JSON is shown with syntax highlighting.

To start, take a look at
the [example](https://github.com/argoproj/argo-workflows/blob/master/examples/artifacts-workflowtemplate.yaml)
.
To start, take a look at the [example](https://github.com/argoproj/argo-workflows/blob/main/examples/artifacts-workflowtemplate.yaml).

![Graph Report](assets/graph-report.png)
![Test Report](assets/test-report.png)
Expand Down
6 changes: 3 additions & 3 deletions docs/client-libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Please expect very minimal support from the Argo team.

| Language | Client Library | Examples/Docs |
|----------|-----------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|
| Golang | [`apiclient.go`](https://github.com/argoproj/argo-workflows/blob/master/pkg/apiclient/apiclient.go) | [Example](https://github.com/argoproj/argo-workflows/blob/master/cmd/argo/commands/submit.go) |
| Java | [Java](https://github.com/argoproj/argo-workflows/blob/master/sdks/java) | |
| Python | [Python](https://github.com/argoproj/argo-workflows/blob/master/sdks/python) | |
| Golang | [`apiclient.go`](https://github.com/argoproj/argo-workflows/blob/main/pkg/apiclient/apiclient.go) | [Example](https://github.com/argoproj/argo-workflows/blob/main/cmd/argo/commands/submit.go) |
| Java | [Java](https://github.com/argoproj/argo-workflows/blob/main/sdks/java) | |
| Python | [Python](https://github.com/argoproj/argo-workflows/blob/main/sdks/python) | |

## Community-maintained client libraries

Expand Down
6 changes: 3 additions & 3 deletions docs/cluster-workflow-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ spec:
workflowTemplateRef:
name: cluster-workflow-template-submittable
clusterScope: true
```
```

Here is an example of a creating `WorkflowTemplate` as Workflow and using `WorkflowTemplates`'s `entrypoint` and `Workflow Arguments`

Expand All @@ -126,13 +126,13 @@ spec:
You can create some example templates as follows:

```bash
argo cluster-template create https://raw.githubusercontent.com/argoproj/argo-workflows/master/examples/cluster-workflow-template/clustertemplates.yaml
argo cluster-template create https://raw.githubusercontent.com/argoproj/argo-workflows/main/examples/cluster-workflow-template/clustertemplates.yaml
```

The submit a workflow using one of those templates:

```bash
argo submit https://raw.githubusercontent.com/argoproj/argo-workflows/master/examples/cluster-workflow-template/cluster-wftmpl-dag.yaml
argo submit https://raw.githubusercontent.com/argoproj/argo-workflows/main/examples/cluster-workflow-template/cluster-wftmpl-dag.yaml
```

> 2.7 and after
Expand Down
14 changes: 7 additions & 7 deletions docs/conditional-artifacts-parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ under step/DAG level output parameter. Both use the

```

* [Steps artifacts example](https://raw.githubusercontent.com/argoproj/argo-workflows/master/examples/conditional-artifacts.yaml)
* [DAG artifacts example](https://raw.githubusercontent.com/argoproj/argo-workflows/master/examples/dag-conditional-artifacts.yaml)
* [Steps artifacts example](https://raw.githubusercontent.com/argoproj/argo-workflows/main/examples/conditional-artifacts.yaml)
* [DAG artifacts example](https://raw.githubusercontent.com/argoproj/argo-workflows/main/examples/dag-conditional-artifacts.yaml)

## Conditional Parameters

Expand All @@ -51,9 +51,6 @@ under step/DAG level output parameter. Both use the
expression: "steps['flip-coin'].outputs.result == 'heads' ? steps.heads.outputs.result : steps.tails.outputs.result"
```
* [Steps parameter example](https://raw.githubusercontent.com/argoproj/argo-workflows/master/examples/conditional-parameters.yaml)
* [DAG parameter example](https://raw.githubusercontent.com/argoproj/argo-workflows/master/examples/dag-conditional-parameters.yaml)
## Built-In Functions
Convenient functions added to support more use cases:
Expand All @@ -65,8 +62,11 @@ Convenient functions added to support more use cases:
e.g: `jsonpath('{"employee":{"name":"sonoo","salary":56000,"married":true}}", "$.employee.name" )` )
5. [Sprig](http://masterminds.github.io/sprig/) - Support all `sprig` functions

* [Advanced example: fibonacci Sequence](https://raw.githubusercontent.com/argoproj/argo-workflows/master/examples/fibonacci-seq-conditional-param.yaml)

!!! NOTE
Expressions will decode the `-` as operator if template name has `-`, it will fail the expression. So here solution
for template name which has `-` in its name. `step['one-two-three'].outputs.artifacts`

* [Steps parameter example](https://raw.githubusercontent.com/argoproj/argo-workflows/main/examples/conditional-parameters.yaml)
* [DAG parameter example](https://raw.githubusercontent.com/argoproj/argo-workflows/main/examples/dag-conditional-parameters.yaml)
* [Advanced example: fibonacci Sequence](https://raw.githubusercontent.com/argoproj/argo-workflows/main/examples/fibonacci-seq-conditional-param.yaml)

Loading

0 comments on commit 5f68d8e

Please sign in to comment.