forked from rancher/prometheus-federator
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update docs, add GH workflows, fix drone stuff, etc.
- Loading branch information
Arvind Iyengar
committed
May 3, 2022
1 parent
917edda
commit 147cae8
Showing
29 changed files
with
650 additions
and
112 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Cluster Setup** | ||
- Kubernetes version: | ||
- Type of Cluster (RKE1, RKE2, k3s, EKS, GKE, AKS, OKE, etc): | ||
- CRD Installation option (Helm Chart / Custom Installation): | ||
- If Helm Chart, did you supply any non-default values? If so, what values did you supply: | ||
- If Custom Installation, how did you install it (kustomize, k8s manifest, etc.): | ||
- Installation option (Helm Chart / Custom Installation): | ||
- If Helm Chart, did you supply any non-default values? If so, what values did you supply: | ||
- If Custom Installation, how did you install it (kustomize, k8s manifest, etc.): | ||
|
||
**Describe the bug** | ||
<!--A clear and concise description of what the bug is.--> | ||
|
||
**To Reproduce** | ||
<!--Steps to reproduce the behavior--> | ||
|
||
**Result** | ||
|
||
**Expected Result** | ||
<!--A clear and concise description of what you expected to happen.--> | ||
|
||
**Screenshots** | ||
<!-- If applicable, add screenshots to help explain your problem.--> | ||
|
||
**Additional context** | ||
<!--Add any other context about the problem here.--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# Configuration for probot-stale - https://github.com/probot/stale | ||
|
||
# Number of days of inactivity before an Issue or Pull Request becomes stale | ||
daysUntilStale: 60 | ||
|
||
# Number of days of inactivity before an Issue or Pull Request with the stale label is closed. | ||
# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale. | ||
daysUntilClose: 14 | ||
|
||
# Only issues or pull requests with all of these labels are check if stale. Defaults to `[]` (disabled) | ||
onlyLabels: [] | ||
|
||
# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable | ||
exemptLabels: | ||
- internal | ||
- kind/bug | ||
- kind/bug-qa | ||
- kind/task | ||
- kind/feature | ||
- kind/design | ||
- kind/ci-improvements | ||
- kind/performance | ||
- kind/flaky-test | ||
|
||
# Set to true to ignore issues in a project (defaults to false) | ||
exemptProjects: true | ||
|
||
# Set to true to ignore issues in a milestone (defaults to false) | ||
exemptMilestones: true | ||
|
||
# Set to true to ignore issues with an assignee (defaults to false) | ||
exemptAssignees: true | ||
|
||
# Label to use when marking as stale | ||
staleLabel: status/stale | ||
|
||
# Comment to post when marking as stale. Set to `false` to disable | ||
markComment: > | ||
This repository uses a bot to automatically label issues which have not had any activity (commit/comment/label) | ||
for 60 days. This helps us manage the community issues better. If the issue is still relevant, please add a comment to the | ||
issue so the bot can remove the label and we know it is still valid. If it is no longer relevant (or possibly fixed in the | ||
latest release), the bot will automatically close the issue in 14 days. Thank you for your contributions. | ||
# Limit the number of actions per hour, from 1-30. Default is 30 | ||
limitPerRun: 30 | ||
|
||
# Limit to only `issues` | ||
only: issues |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# This workflow uses actions that are not certified by GitHub. | ||
# They are provided by a third-party and are governed by | ||
# separate terms of service, privacy policy, and support | ||
# documentation. | ||
|
||
name: Label issues | ||
on: | ||
issues: | ||
types: | ||
- opened | ||
- reopened | ||
jobs: | ||
label_issues: | ||
runs-on: ubuntu-latest | ||
permissions: | ||
issues: write | ||
steps: | ||
- name: Label issues | ||
uses: andymckay/labeler@e6c4322d0397f3240f0e7e30a33b5c5df2d39e90 | ||
with: | ||
add-labels: "team/area3" | ||
repo-token: ${{ secrets.GITHUB_TOKEN }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
name: CI-pullrequest | ||
|
||
on: [pull_request] | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
container: | ||
image: rancher/dapper:v0.5.4 | ||
steps: | ||
- uses: actions/checkout@v1 | ||
- name: Run CI | ||
run: dapper ci |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,4 +5,5 @@ | |
*.swp | ||
.idea | ||
/prometheus-federator | ||
/.charts-build-scripts | ||
/.charts-build-scripts | ||
*.DS_Store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* @aiyengar2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Contributor Code of Conduct | ||
|
||
As contributors and maintainers of this project, and in the interest of fostering | ||
an open and welcoming community, we pledge to respect all people who contribute | ||
through reporting issues, posting feature requests, updating documentation, | ||
submitting pull requests or patches, and other activities. | ||
|
||
We are committed to making participation in this project a harassment-free experience for | ||
everyone, regardless of level of experience, gender, gender identity and expression, | ||
sexual orientation, disability, personal appearance, body size, race, ethnicity, age, | ||
religion, or nationality. | ||
|
||
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 other's private information, such as physical or electronic addresses, | ||
without explicit permission | ||
* Other unethical or unprofessional conduct. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or reject | ||
comments, commits, code, wiki edits, issues, and other contributions that are not | ||
aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers | ||
commit themselves to fairly and consistently applying these principles to every aspect | ||
of managing this project. | ||
|
||
This code of conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by | ||
contacting a Rancher administrator on [Slack](https://slack.rancher.io), or <[email protected]>. | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
# Contributing to rancher/helm-project-operator | ||
|
||
Thank you for investing your time in contributing to our project! | ||
|
||
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. | ||
|
||
## New contributor guide | ||
|
||
To get an overview of the project, read the [README](README.md). Here are some resources to help you get started with open source contributions: | ||
|
||
- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) | ||
- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git) | ||
- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) | ||
- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests) | ||
|
||
|
||
## Getting started | ||
|
||
### Issues | ||
|
||
#### Create a new issue | ||
|
||
If you spot a problem with the docs, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new [issue](https://github.com/rancher/helm-project-operator/issues/new). | ||
|
||
#### Solve an issue | ||
|
||
Scan through our [existing issues](https://github.com/rancher/helm-project-operator/issues) to find one that interests you. If you find an issue to work on, you are welcome to open a PR with a fix. | ||
|
||
### Make Changes | ||
|
||
#### Make changes locally | ||
|
||
1. Install [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) or [GitHub Desktop](https://desktop.github.com/) | ||
|
||
2. Fork the repository. | ||
- Using GitHub Desktop: | ||
- [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop. | ||
- Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)! | ||
|
||
- Using the command line: | ||
- [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them. | ||
|
||
3. Install or update to **Go 1.17**. For more information, see [the development guide](docs/developing.md). | ||
|
||
4. Create a working branch and start with your changes! | ||
|
||
### Commit your update | ||
|
||
Commit the changes once you are happy with them. See [Atom's contributing guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages) to know how to use emoji for commit messages. | ||
|
||
### Pull Request | ||
|
||
When you're finished with the changes, create a pull request, also known as a PR. | ||
- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one. | ||
- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge. | ||
Once you submit your PR, a Rancher team member will review your proposal. We may ask questions or request for additional information. | ||
- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch. | ||
- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations). | ||
- If you run into any merge issues, checkout this [git tutorial](https://lab.github.com/githubtraining/managing-merge-conflicts) to help you resolve merge conflicts and other issues. | ||
|
||
### Your PR is merged! | ||
|
||
Congratulations :tada::tada: The Rancher team thanks you :sparkles:. | ||
|
||
Once your PR is merged, your contributions will be publicly visible on the [`rancher/helm-project-operator`](https://github.com/rancher/helm-project-operator). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.