gitea/helm-chart
45
55
Fork 125
Code Issues 32 Pull Requests 8 Actions Releases 87 Activity

Improve contribution part of this repository #328

Merged
techknowlogick merged 8 commits from justusbunsi/helm-chart:improve-how-to-contribute into master 2022-06-12 19:35:25 +00:00
Conversation 2 Commits 8 Files Changed 12 +863 -38
justusbunsi commented 2022-06-11 16:25:52 +00:00
Member
Copy Link

Signed-off-by: justusbunsi sk.bunsenbrenner@gmail.com

Description of the change

This Pull Request is dedicated to all the contributors of this repository.
It introduces a contributing guideline, (hopefully) clear instructions on
how to make changes and a template for pull requests which helps to have
a well-defined PR description.

Benefits

We use readme-generator-for-helm and markdownlint-cli which are both
NPM packages. So they should be available for developers in a more usual
way: package.json and package-lock.json. That way, contributors will
have the same environment as it exists during CI builds.

With the recent switch to auto-generate the parameters inside README.md,
contributors should integrate an updated README.md into the pull request.

A Drone build now ensures that the README.md is properly updated by
running the script a contributor should run and checks for uncommitted
changes for README.md. If this produces a change, the build fails.

Additional information

As the currently used readme-generator-for-helm from npmjs.com is not
officially maintained by Bitnami (see issue link below), the change also
includes switching to the official GitHub repository.

https://github.com/bitnami-labs/readme-generator-for-helm/issues/36

Signed-off-by: justusbunsi <sk.bunsenbrenner@gmail.com> ### Description of the change This Pull Request is dedicated to all the contributors of this repository. It introduces a contributing guideline, (hopefully) clear instructions on how to make changes and a template for pull requests which helps to have a well-defined PR description. ### Benefits We use `readme-generator-for-helm` and `markdownlint-cli` which are both NPM packages. So they should be available for developers in a more usual way: `package.json` and `package-lock.json`. That way, contributors will have the same environment as it exists during CI builds. With the recent switch to auto-generate the parameters inside README.md, contributors should integrate an updated README.md into the pull request. A Drone build now ensures that the README.md is properly updated by running the script a contributor should run and checks for uncommitted changes for README.md. If this produces a change, the build fails. ### Additional information As the currently used `readme-generator-for-helm` from npmjs.com is not officially maintained by Bitnami (see issue link below), the change also includes switching to the official GitHub repository. https://github.com/bitnami-labs/readme-generator-for-helm/issues/36
👍 1
justusbunsi added 4 commits 2022-06-11 16:25:53 +00:00
Introduce NPM dependencies for development 
We use `readme-generator-for-helm` and `markdownlint-cli` which are both
NPM packages. So they should be available for developers in a more usual
way: `package.json` and `package-lock.json`.

As the currently used `readme-generator-for-helm` from npmjs.com is not
officially maintained by Bitnami (see issue link below), the change also
includes switching to the official GitHub repository.

https://github.com/bitnami-labs/readme-generator-for-helm/issues/36

Signed-off-by: justusbunsi <sk.bunsenbrenner@gmail.com>
3c8cfe8f46
Integrate readme integrity check into CI 
With the recent switch to auto-generate the parameters inside README.md,
contributors should integrate an updated README.md into the pull request.

A Drone build now ensures that the README.md is properly updated by
running the script a contributor should run and checks for uncommitted
changes for README.md. If this produces a change, the build fails.

Signed-off-by: justusbunsi <sk.bunsenbrenner@gmail.com>
af2cc490ac
Introduce pull request template 
It is highly inspired by the one from the Bitnami Charts repository.

https://raw.githubusercontent.com/bitnami/charts/master/.github/PULL_REQUEST_TEMPLATE.md

Signed-off-by: justusbunsi <sk.bunsenbrenner@gmail.com>
8f3dffd7da
Introduce contribution guidelines 
Signed-off-by: justusbunsi <sk.bunsenbrenner@gmail.com>
Some checks failed
continuous-integration/drone/pr Build is failing
Details
af7653d03d
justusbunsi added 1 commit 2022-06-11 16:48:35 +00:00
Use tarball logic to avoid SSH issues 
Signed-off-by: justusbunsi <sk.bunsenbrenner@gmail.com>
All checks were successful
continuous-integration/drone/pr Build is passing
Details
926c59200a
justusbunsi added 1 commit 2022-06-11 16:53:14 +00:00
Enforce CI to fail 
Signed-off-by: justusbunsi <sk.bunsenbrenner@gmail.com>
Some checks failed
continuous-integration/drone/pr Build is failing
Details
6fb8455d85
justusbunsi added 1 commit 2022-06-11 16:55:19 +00:00
Revert "Enforce CI to fail" 
This reverts commit 6fb8455d85.

Signed-off-by: justusbunsi <sk.bunsenbrenner@gmail.com>
All checks were successful
continuous-integration/drone/pr Build is passing
Details
0dec8fbaf4
justusbunsi commented 2022-06-11 17:07:54 +00:00
Author
Member
Copy Link

I've verified that the CI actually fails if the README.md is not properly updated: 6fb8455d85

I've verified that the CI actually fails if the README.md is not properly updated: https://gitea.com/gitea/helm-chart/commit/6fb8455d85939bebd20c77d3fccbf3cc13469ec0
justusbunsi changed title from improve-how-to-contribute to Improve contribution part of this repository 2022-06-11 17:09:25 +00:00
techknowlogick approved these changes 2022-06-11 19:08:27 +00:00
techknowlogick left a comment
Owner
Copy Link

LGTM, probably could switch to alpine 3.16 in drone file, but I don't consider that blocking.

LGTM, probably could switch to alpine 3.16 in drone file, but I don't consider that blocking.
justusbunsi added 1 commit 2022-06-12 10:37:22 +00:00
Bump alpine to 1.16 
Signed-off-by: justusbunsi <sk.bunsenbrenner@gmail.com>
All checks were successful
continuous-integration/drone/pr Build is passing
Details
3bd1a5aac0
justusbunsi commented 2022-06-12 10:38:54 +00:00
Author
Member
Copy Link

@techknowlogick Sure. I've bumped the Alpine image.

@techknowlogick Sure. I've bumped the Alpine image.
techknowlogick merged commit 2cc3195eaa into master 2022-06-12 19:35:25 +00:00
justusbunsi deleted branch improve-how-to-contribute 2022-06-13 11:07:10 +00:00
justusbunsi added the
kind
docs
 label 2022-06-25 16:51:06 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
techknowlogick
Labels
Clear labels   
has
backport

  
in progress

   
invalid
  
kind
breaking

  
kind
bug

  
kind
build

  
kind
dependency

  
kind
deployment

  
kind
docs

  
kind
enhancement

  
kind
feature

  
kind
lint

  
kind
proposal

  
kind
question

  
kind
refactor

  
kind
security

  
kind
testing

  
kind
translation

  
kind
ui

  
need
backport

  
priority
critical

  
priority
low

  
priority
maybe

  
priority
medium

  
reviewed
duplicate

  
reviewed
invalid

  
reviewed
wontfix

  
skip-changelog
  
status
blocked

  
status
needs-feedback

  
status
needs-reviews

  
status
wip

  
upstream
gitea

  
upstream
other

No Label
has
backport
in progress
invalid
kind
breaking
kind
bug
kind
build
kind
dependency
kind
deployment
kind
docs
kind
enhancement
kind
feature
kind
lint
kind
proposal
kind
question
kind
refactor
kind
security
kind
testing
kind
translation
kind
ui
need
backport
priority
critical
priority
low
priority
maybe
priority
medium
reviewed
duplicate
reviewed
invalid
reviewed
wontfix
skip-changelog
status
blocked
status
needs-feedback
status
needs-reviews
status
wip
upstream
gitea
upstream
other
Milestone
Clear milestone
No items
No Milestone
Assignees
Clear assignees
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: gitea/helm-chart#328
No description provided.
Delete Branch "justusbunsi/helm-chart:improve-how-to-contribute"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?