diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md deleted file mode 100644 index 9c0c0198e..000000000 --- a/.github/pull_request_template.md +++ /dev/null @@ -1,52 +0,0 @@ -# Changes - - - - - - - -# Submitter Checklist - -- [ ] Includes tests if functionality changed/was added -- [ ] Includes docs if changes are user-facing -- [ ] [Set a kind label on this PR](https://prow.k8s.io/command-help#kind) -- [ ] Release notes block has been filled in, or marked NONE - -See [the contributor guide](https://github.com/shipwright-io/build/blob/main/CONTRIBUTING.md) -for details on coding conventions, github and prow interactions, and the code review process. - -# Release Notes - - diff --git a/.github/workflows/issues.yml b/.github/workflows/issues.yml new file mode 100644 index 000000000..356b0cbb1 --- /dev/null +++ b/.github/workflows/issues.yml @@ -0,0 +1,20 @@ +name: Add issue or pull request to Project + +on: + issues: + types: + - opened + pull_request_target: + types: + - opened + - reopened + +jobs: + add-to-project: + runs-on: ubuntu-latest + steps: + - name: Add issue to project + uses: actions/add-to-project@v0.5.0 + with: + project-url: https://github.com/orgs/shipwright-io/projects/6 + github-token: ${{ secrets.ADD_TO_PROJECT_TOKEN }} diff --git a/2021-roadmap.md b/2021-roadmap.md deleted file mode 100644 index 885f72054..000000000 --- a/2021-roadmap.md +++ /dev/null @@ -1,64 +0,0 @@ - -# **Shipwright 2021 Roadmap** - -**Mission Statement:** Shipwright aims to do one thing well: build images from source. Automatically, securely, reliably. - -Features that further that goal should be welcomed, and prioritized to optimize that goal. Features that don't should be improved and removed if necessary. - -Shipwright should be simple to use and flexible to extend. Once set up, it should run smoothly for users and operators alike, and when failures happen (they always do) they should be easy to diagnose and fix. - - -1. **Build ← you are here!** - * Pluggable BuildStrategies, with pre-defined support for Buildpacks, Kaniko, S2i, Buildah; users can modify, install their own - * Continue to improve built-in BuildStrategies for security best practices ([#169](https://github.com/shipwright-io/build/issues/169)) -2. **API Improvements / Simplification** - * The API should be small, powerful and easy to use - * Synchronous webhook validation ([#685](https://github.com/shipwright-io/build/pull/685)) - * Deprecate and remove BuildStatus and BuildStrategyStatus - * BuildRun status should include resolved git commit ([#205](https://github.com/shipwright-io/build/issues/205)) and built image digest ([#618](https://github.com/shipwright-io/build/issues/618)) - * BuildStrategy Parameterization ([#697](https://github.com/shipwright-io/build/pull/697)) - * Move builder + dockerfile fields to strategy-specific params - * Don’t rely on `creds-init` or PipelineResources ([#696](https://github.com/shipwright-io/build/issues/696)) - * These features not likely to be extended to Tekton v1 - * Remove auto-generating SAs at runtime ([#679](https://github.com/shipwright-io/build/issues/679)) - * [API Review](https://github.com/shipwright-io/build/issues/516) + API Hygiene - * Remove deprecated BuildRun status fields ([#517](https://github.com/shipwright-io/build/issues/517)) - * **Note:** Breaking API changes are _allowed_ in alpha, and should be encouraged where they improve the experience, but must be carried out responsibly. - * Remove or scope down `runtime-image` support - * Multiple inputs / volumes ([EP](https://github.com/shipwright-io/build/blob/master/docs/proposals/remote-artifacts.md)) - * Some feature like [`runPolicy`](https://docs.openshift.com/container-platform/4.7/cicd/builds/advanced-build-operations.html#builds-build-run-policy_advanced-build-operations): `Serial` / `Parallel` / `SerialLatestOnly` - * **Note:** The above is not intended to be an exhaustive list of features/bugs we intend to close in 2021 -3. **Project Hygiene + Health** - * The project should run well, making new contributions easy - * Docs / website, blogs, tutorials ([#700](https://github.com/shipwright-io/build/issues/700)), conference talks - * [CI / flakebusting](https://github.com/shipwright-io/build/issues/653) -- stamping out flakes improves contributor experience, accelerates project growth -4. **Community Governance** - * Donate project and "Shipwright" trademark to a foundation - * Establish vendor-neutral governance model -5. **Triggering** - * "Put both C’s in CI/CD" -- Builds should be able to create BuildRuns automatically - * Watch a repo (or image, or other things) and create new BuildRuns -6. **CLI** - * Using Shipwright shouldn't require `kubectl` - * The CLI should make logs easier, especially, to make debugging failed builds better. - * CLI to create/watch BuildRuns helps with integrations with other tooling (Tekton, Jenkins, etc.) - * CLI should support some way to build on-cluster from local source -- this might require API changes ([IBM demoed in February](https://github.com/shipwright-io/build/issues/551#issuecomment-771002913)) -7. **Operator / Operations** - * Installing and managing a Shipwright installation should be easy - * Upgrade installation - * Upgrade installed BuildStrategies - * Configure Shipwright with a `ConfigMap` instead of controller flags/envs ([#651](https://github.com/shipwright-io/build/issues/651)) - * Metrics / Observability - * Scaling / Load Testing -- Shipwright should not be a bottleneck -8. **Rebase** ([#656](https://github.com/shipwright-io/build/issues/656)) - * Quickly and efficiently picking up security fixes can be as important as producing images from new source - * w/ Triggering, enables watching a base image, producing rebased images quickly β†’ CVE-to-deployed-fix time should be as short as possible -9. **Integrations** - * Shipwright exists among a community of projects; we should work well together with others - * Document + demo running a Build inside a Tekton Pipeline using Custom Task - * Document + demo triggering rollouts after Shipwright produces an image - * Document + blog about niche build strategies (e.g., Bazel?) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 52dabdbbd..000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,61 +0,0 @@ - - -# Contributing Guidelines - -Welcome to Shipwright Build. We are excited about the prospect of you contributing to our project. Your support is more than welcome! - -## Getting Started - -We have initial documentation on how to start contributing here: - -- Learn how to [change shipwright and try out your changes on a local cluster](/docs/development/local_development.md) -- Our main [documentation](/docs/) -- Our [Code of Conduct](/code-of-conduct.md) - -## Creating new Issues - -We recommend to open an issue for the following scenarios: - -- Asking for help or questions. (_Use the **discussion** or **help_wanted** label_) -- Reporting a Bug. (_Use the **bug** label_) -- Requesting a new Feature. (_Use the **enhancement** label_) - -The Shipwright maintainers can also be reached in our [Kubernetes Slack channel](https://kubernetes.slack.com/archives/C019ZRGUEJC). - -## Writing Pull Requests - -Contributions can be submitted by creating a pull request on Github. We recommend you do the following to ensure the maintainers can collaborate on your contribution: - -- Fork the project into your personal Github account -- Create a new feature branch for your contribution -- Make your changes -- If you make code changes, ensure unit tests are passing by running `make test-unit` -- Open a PR with a nice description and a link to the Github issue where the changes were previously discussed. - -## Code review process - -There is an integration on our Github repository that automatically do things for us. Once a PR is open the tool will assign two members of the project for the code review. - -The code review should cover: - -- Ensure all related tests(unit, integration and e2e) are passing. -- Ensure the code style is compliant with the [coding conventions](https://github.com/kubernetes/community/blob/master/contributors/guide/coding-conventions.md) -- Ensure the code is properly documented, e.g. enough comments where needed. -- Ensure the code is adding the necessary test cases(unit, integration or e2e) if needed. - -## Community Meetings Participation - -We run the community meetings every Monday at 13:00 UTC time. -For each upcoming meeting we generate a new issue where we layout the topics to discuss. -See our [previous meetings](https://github.com/shipwright-io/build/issues?q=is%3Aissue+label%3Acommunity+is%3Aclosed) outcomes. -To join, please request an invite in our Slack [channel](https://kubernetes.slack.com/archives/C019ZRGUEJC). - -## Contact Information - -- [Slack channel](https://kubernetes.slack.com/archives/C019ZRGUEJC) -- End-user email list: [shipwright-users@lists.shipwright.io](https://lists.shipwright.io/admin/lists/shipwright-users.lists.shipwright.io/) -- Developer email list: [shipwright-dev@lists.shipwright.io](https://lists.shipwright.io/admin/lists/shipwright-dev.lists.shipwright.io/) diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 55603b668..000000000 --- a/SECURITY.md +++ /dev/null @@ -1,10 +0,0 @@ - -# Shipwright Security and Disclosure Information - -Shipwright encourages all users and contributors to report potential security vulnerabilities to the project maintainers. -If you think you have found a security flaw related to Shipwright's code, please send a report to . -Encryption using GPG is NOT required to make a disclosure. diff --git a/code-of-conduct.md b/code-of-conduct.md deleted file mode 100644 index 01ffccbf2..000000000 --- a/code-of-conduct.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# Shipwright Code of Conduct - -Shipwright follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery -* Personal attacks -* Trolling or insulting/derogatory comments -* Public or private harassment -* Publishing others' private information, such as physical or electronic addresses, without explicit permission -* Other unethical or unprofessional conduct. - -Contributors are expected to adhere to the code of contact in all interactions with fellow Shipwright community members, which includes electronic communications (email, Slack) as well as direct in-person contact. -Violators of the code of conduct are subject to removal from relevant project forums. - -If you witness a violation of the code of conduct, please report it to the Shipwright maintainers by emailing .