Skip to content

Commit

Permalink
Merge pull request RHEcosystemAppEng#3 from redhatHameed/adding-pr-te…
Browse files Browse the repository at this point in the history
…mplate

adding PR template and updated README file
  • Loading branch information
jeremyary authored Apr 30, 2021
2 parents fa378a3 + 9fee59c commit e21f1d9
Show file tree
Hide file tree
Showing 4 changed files with 54 additions and 1 deletion.
3 changes: 3 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# These owners will be the default owners for everything in the repo

* @jeremyary
27 changes: 27 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## Description
<!-- Please include a summary of the change and link to the related Jira issue. Please add any additional motivation and context as needed. Screenshots are also welcome -->

## Verification Steps
<!--
Add the steps required to check this change. Following an example.
1. Go to `XX >> YY >> SS`
2. Create a new item `N` with the info `X`
3. Try to edit this item
4. Check if in the left menu the feature X is not so long present.
-->

## Type of change
<!-- Please delete options that are not relevant. -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

## Checklist (Definition of Done)
<!-- Please strikethrough options not relevant using two tildes ~~Text~~. Do not delete non relevant options -->
- [ ] All acceptance criteria specified in JIRA or in issue number have been completed
- [ ] Unit tests added that prove the fix is effective or the feature works
- [ ] Documentation added for the feature
- [ ] all relevant tests are passing
- [ ] Code Review completed
- [ ] Verified independently by reviewer
2 changes: 2 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ endif

all: build

release: build generate bundle docker-build docker-push bundle-build bundle-push catalog-build catalog-push

##@ General

# The help target prints out all targets with their descriptions organized
Expand Down
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,25 @@
- create feature branches within your fork to complete your work
- raise PR's from your feature branch targeting upstream main branch
- add `jeremyary` (and others as needed) as reviewer


## Building and Running the Operator

- Update the `Makefile` and edit `IMAGE_TAG_BASE`, with your Quay.io `ORG` name.

- To build and push the operator, bundle and index images, you just need to run: `make release`

**Run locally outside the cluster**: Run `make install run`

**Deploy manualy inside the cluster**: Run `make deploy`

**Deploy With OLM**: Run `operator-sdk run bundle quay.io/ecosystem-appeng/dbaas-operator-bundle:<TAG>`

**Create the CR**: `oc apply -f config/samples/dbaas_v1_dbaasservice.yaml -n <namesapce> `

**Cleanup**:

`oc delete -f config/samples/dbaas_v1_dbaasservice.yaml -n <namesapce> `

`make undeploy`

Cleanup from OLM: `operator-sdk cleanup dbaas-operator`

0 comments on commit e21f1d9

Please sign in to comment.