17 Commits
Author SHA1 Message Date
Ayush KumarandGitHub 5b70fcc006 Docs: overhaul CONTRIBUTING.md and issue templates (#7337)
* Docs: overhaul CONTRIBUTING.md and issue templates

Expand the root CONTRIBUTING.md from a one-line redirect into a real front door covering the Code of Conduct, ways to contribute, DCO sign-off, and links to governance and security. Convert the bug and feature issue templates from free-text Markdown into GitHub issue forms with required version fields and a duplicate-search checkbox, merging the separate enhancement template into the feature form. Fix stale oam-dev/kubevela references in bot.md, issue-commands.json, and ISSUE_TRIAGE.md, add a Security contact link and disable blank issues in the issue template config, and add a DCO checklist item to the pull request template.

Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com>

Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com>

* Docs: expand GOVERNANCE.md and community.md stubs

GOVERNANCE.md and community.md were one and two line redirects to the community repo. Both now cover Code of Conduct, meetings, KEP process, membership ladder, security, and releases (GOVERNANCE.md) or communication channels, how to get involved, and governance links (community.md), as short maps that link out to the community repo for anything that changes often, rather than duplicating it. CONTRIBUTING.md's Communication line now points at the local community.md first.

Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com>

Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com>

* Docs: rename community.md to COMMUNITY.md

Match the all-caps naming used by CONTRIBUTING.md, GOVERNANCE.md, CODE_OF_CONDUCT.md, and SECURITY.md.

Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com>

Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com>

* Docs: fix stale domains in README and de-duplicate ISSUE_TRIAGE.md

README.md had three kubevela.net links left over from the domain move to kubevela.io, and a Contact Us / Community Call section that duplicated, and disagreed with on cadence, what COMMUNITY.md now documents. Point Community, Contributing, and Report Vulnerability at the local COMMUNITY.md, CONTRIBUTING.md, and SECURITY.md instead of re-describing them inline.

ISSUE_TRIAGE.md was a full copy of the community repo's canonical document. That's how it went stale in the first place, still referencing oam-dev/kubevela after the org move. Replaced it with a short pointer to the canonical copy, matching how GOVERNANCE.md and COMMUNITY.md already work.

Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com>

Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com>

* Docs: bring contribute/ folder up to the same standard

These six files were the original bare-stub redirects this whole pass started from. Their links were already correct, unlike everything else touched in this branch, but they were the last remaining one-line 'please refer to X' pages in the repo. Each now has a short line of real context before the link, and README.md cross-links the new CONTRIBUTING.md front door instead of only pointing out to kubevela.io.

Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com>

Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com>

* Docs: remove contribute/ folder, fold it into CONTRIBUTING.md

The contribute/ folder was six tiny files that each pointed at one kubevela.io page, and every one of those pages was already linked from CONTRIBUTING.md's Ways to contribute and More sections. Keeping both meant two indexes into the same handful of pages, organized differently, with no content of its own beyond the links. Folded the two links CONTRIBUTING.md was missing, code conventions and test principles, into the Code bullet, and removed the folder. The develop-code-flow.pdf diagram wasn't linked from anywhere in the repo and duplicates what release-process.md already covers, so it goes too.

PULL_REQUEST_TEMPLATE.md's contribution process checklist item pointed at contribute/create-pull-request.md; repointed it at CONTRIBUTING.md. Confirmed with a repo-wide grep that nothing else referenced the contribute/ path.

Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com>

Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com>

* Docs: fix dangling references flagged by review

Three real issues from automated review, still present at HEAD: GOVERNANCE.md's membership sentence read as four roles after three levels beyond contributor instead of three, missing a colon. README.md claimed the meeting schedule lives in COMMUNITY.md, which explicitly says it doesn't. ISSUE_TRIAGE.md attributed the type/area/priority label taxonomy to COMMUNITY.md, which never describes those labels, repointed to the canonical ISSUE_TRIAGE.md already linked at the top of the same file.

Two other flagged issues (CONTRIBUTING.md's issue-triage and governance links) were valid against an earlier commit but got resolved in the opposite direction by later commits in this branch, converting ISSUE_TRIAGE.md and GOVERNANCE.md into pointers/maps rather than repointing links at them. The type/feature label flag is accurate but intentional, a maintainer is creating that label.

Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com>

Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com>

* Docs: split feature and enhancement issue forms back apart

The merged feature_request.yml applied type/feature regardless of which option the kind dropdown picked, silently dropping the type/enhancement distinction the old enhancement_request.md preserved and that ISSUE_TRIAGE.md and issue-commands.json still reference. GitHub issue forms can't conditionally set a label based on a form answer, so the only way to keep both labels working is two templates again: feature_request.yml (type/feature, for net-new capability) and enhancement_request.yml (type/enhancement, for improving something that exists), each asking only the questions relevant to that case.

Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com>

Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com>

* Docs: link PR template directly to the pull request process

CONTRIBUTING.md is a front door, not the PR process itself, it links out to code-contribute.md for that. Pointing the PR template's checklist item straight at the section with the actual process (title format, DCO, backport labels) saves the contributor an extra hop at the exact moment they're creating a PR, matching how Kubernetes and Crossplane link their PR templates directly to the dev guide. Verified the anchor resolves on the live page before pushing.

Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com>

Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com>

* Docs: add a Quick start section to CONTRIBUTING.md

Compared to peer CNCF projects (Kubernetes, Crossplane, etcd, Helm), CONTRIBUTING.md had zero runnable commands, a contributor had to click through to kubevela.io just to learn how to build or test locally. Added the three commands that matter most (make, make test, make reviewable, all verified against the actual Makefile targets) so the basics don't require leaving the repo.

Left the fuller dev environment setup, coding style rules, and PR lifecycle narrative as link-outs rather than duplicating them here, that content is detailed enough (Go/kustomize/CUE/kubebuilder versions, VelaUX, e2e setup) that inlining it would just recreate the drift problem ISSUE_TRIAGE.md had before this PR.

Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com>

Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com>

* Docs: document commit message format in CONTRIBUTING.md

etcd, Kubernetes, and Helm all state their commit message convention directly in CONTRIBUTING.md. KubeVela has one too (Type: subject, documented in full at code-contribute.md#formatting-guidelines) but it was never mentioned here. Added the format and three real examples inline, kept the full scope/area rules and PR title/squash policy as a link-out rather than duplicating all of it.

Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com>

Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com>

* Docs: drop unrelated tagline from bot comments

issue-commands.json's bot/duplicate and bot/no new info comments both ended with 'Happy graphing!', a leftover from some other project's bot config with nothing to do with KubeVela. Already editing this file for the org-name fixes, so dropped the tagline from both, and fixed a duplicated 'you you' typo in the second one while there.

Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com>

Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com>

* Docs: break up long Ways to contribute bullets

The Code bullet ran past 400 characters on one line. Split Code, Docs, Issue triage, and Everything else into a lead-in plus sub-bullets, matching Crossplane's CONTRIBUTING style, left Answer questions as a single line since it was already short enough to scan. No content changed, just line length.

Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com>

Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com>

* Docs: add existing-issue-search checkbox to feature and enhancement forms

bug_report.yml has a required checkbox confirming the reporter searched for duplicates first; feature_request.yml and enhancement_request.yml didn't, despite Kubernetes applying this consistently across all its issue forms. Added the same required checkbox to both, worded for a feature/enhancement rather than a bug.

Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com>

Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com>

* Docs: fix comma splice in COMMUNITY.md

Split one sentence into two instead of joining them with a comma.

Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com>

Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com>

* Chore: add roguepikachu to comment.userlist

Grants triage bot comment command access per bot.md.

Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com>

Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com>

---------

Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com>
2026-08-19 13:33:30 +01:00
Jianbo SunandGitHub 493a609864 Chore: trim updated docs, make the source clean (#3946)
Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>
2022-05-22 15:13:41 +08:00
Jianbo SunandGitHub 755ccad654 Chore: update some docs to the new org url (#3792)
Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>
2022-04-29 15:59:29 +08:00
Jianbo SunandGitHub 32382ba6be Chore: add new code flow for kubevela milestone (#3586)
Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>
2022-04-06 13:34:30 +08:00
qiaozpandGitHub 4eafb46c87 Chore: bump test k8s to 1.20 (#3567)
Signed-off-by: qiaozp <chivalry.pp@gmail.com>
2022-03-31 22:12:55 +08:00
barnettZQGandGitHub 17794e4ce1 Fix: upgrade package github.com/docker/cli for CVE-2021-41092 (#3216)
* Fix: upgrade package github.com/docker/cli for CVE-2021-41092

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>

* Chore: change go version to 1.17

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>

* Chore: change go mod

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>

* Fix: change install cue shell

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>
2022-02-09 19:18:40 +08:00
b17abe0081 Fix: add cue binary requirement in Development doc (#3062)
* Fix: add cue binary requirement in Development doc

If the version of cue binary is less than v0.3.0, like v0.2.0, `make reviewable`
will fail due to issue: "make: *** [fmt] Error 1". As `make reviewable` is a
required step for code contribution, add this prerequiste in the doc.

Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com>

* Update contribute/developer-guide.md

Co-authored-by: Jianbo Sun <wonderflow.sun@gmail.com>

Co-authored-by: Jianbo Sun <wonderflow.sun@gmail.com>
2022-01-10 13:01:46 +08:00
5648c56cf5 Refactor: align velaux env and CLI env, they both use K8s namespace as (#2975)
* Refactor: use createOrUpdateNamespace as a common util function

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

* Feat: add ENV webservice handelr

* Fix: fix Env usecase logic

* Feat: Add Delete Env API

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

* Fix: filter empty addon data

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

* Feat: split makefiels and make it clear

* Feat: add k8s utils test

* Feat: Add env update interface

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

* Feat: change env implementation

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>

* Fix: minor fix

* Revert "Fix: minor fix"

This reverts commit 9cafefa65a.

* Fix: use appusecase as parameter

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

* Refactor: align CLI vela env with new env design

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

* Fix: minor fix

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

* Feat: add page index and alias of env

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

* Fix: fix tests and licence header

* Fix: fix makefile and add default target

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

* Fix: update build swagger.json

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

* Fix: change update env api

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>

* Feat: list env with alias

* Feat: add log to env delete

* Fix: can not get app status

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>

* Feat: support update workflow and refactor code

* Fix: lint

* Fix: remove swagger check

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

* Fix: fix cli vela delete

* Fix: update test

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

* Fix: update test

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

* Fix: app deploy unit test case

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>

* Fix: SortOrderDescending is not effective

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>

* Fix: e2e test case

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>

* Feat: support default project/target/env

* Fix: make test and add swagger

* Fix: use separated datasource for unit test

* Fix: app rollback bug

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>

* Fix: fix e2e test

* Fix: kubeapi driver sort bug

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>

* Fix: e2e test

* Fix: api e2e test

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>

* Fix: e2e test fix

* Fix: try fix e2e test

* Fix: api e2e test

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>

Co-authored-by: barnettZQG <barnett.zqg@gmail.com>
2021-12-25 10:36:54 +08:00
Tianxin DongandGitHub f5e04a5575 Fix: fix apiserver snake case (#2944)
Signed-off-by: FogDong <dongtianxin.tx@alibaba-inc.com>
2021-12-16 21:14:25 +08:00
Tianxin DongandGitHub 952af10a4b Fix: check pr title instead of commit msg (#2541) 2021-10-23 00:28:59 +08:00
0d036e7449 Feat: initialize the Apiserver framework (#2417)
* Feat: add kubeapi and mongodb datastore implementation

* Style: change kubeapi import code style

* Style: change mongodb package import code style

* Style: add some comment

* Style: change databasePrefix to tableNamePrefix

* Chore: install mongodb in unit-test job

* Chore: install mongodb in compatibility-test job

* Feat: add apiserver e2e test case

* Docs: change developer guide doc

* Feat: use common.Scheme

Co-authored-by: barnettZQG <yiyun.pro>
2021-10-12 11:53:24 +08:00
Jianbo SunandGitHub cad21c5138 Fix: refactor workflow and fix some e2e tests (#2272)
* Fix: add e2e plugin test back

* Fix: e2e rollout test and try change port to 37081

* Fix: add rollout plan test back

* Refactor: change the workflow state machine and add workflow succeed state

* Refactor: refine definition controller and fix e2e of app revision

* Refactor: unlock all the normal cases

* Fix: add helm schematic logic back into workflow
2021-09-13 14:17:12 +08:00
Tianxin DongandGitHub 75eab7bdde Docs: remove the commit convention doc (#2187) 2021-08-30 11:41:01 +08:00
Jianbo SunandGitHub aa87d3da24 upgrade K8s dependency lib to v0.21 (#1985)
* upgrade K8s dependency to v0.21

* update CRD for new version of controller-runtime

* fix ci component revision create must fill Raw in runtime.RawExtension

* try fix test

* start control plane timeout set to 1min and fix tests

* add timeout for env test start and stop

* longer timeout time for BeforeSuit function

* upgrade kubebuilder and k8s cluster version to match with v1.21.2 in github action

* fix test

* fix resource tracker ownerRef override

* update developer guides
2021-08-03 11:30:02 +08:00
wangyuan249andGitHub d77969b52e Help developer install build-in necessary definitions. (#1907)
* fix

* add install def shell

* change to make command

* fix shell

* fix bak
2021-07-20 14:05:39 +08:00
b2adf5b472 Create a guide of test level maintainance (#1852)
* Create testcode-guidance.md

* Update contribute/testcode-guidance.md

* Update testcode-guidance.md

Co-authored-by: Jianbo Sun <wonderflow.sun@gmail.com>
2021-06-28 15:07:16 +08:00
046376aa1a refine our contributing guides (#1807)
* refine our contribute guides

* Update CONTRIBUTING.md

Co-authored-by: Hongchao Deng <hongchaodeng1@gmail.com>

Co-authored-by: Hongchao Deng <hongchaodeng1@gmail.com>
2021-06-16 20:56:19 +08:00