Improve contribution part of this repository #328

2022-06-11T16:25:52Z

justusbunsi commented

2022-06-11 16:25:52 +00:00

(Migrated from gitea.com)

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 commented

2022-06-11 17:07:54 +00:00

(Migrated from gitea.com)

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

techknowlogick (Migrated from gitea.com) approved these changes 2022-06-11 19:08:27 +00:00

techknowlogick (Migrated from gitea.com) left a comment

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

justusbunsi commented

2022-06-12 10:38:54 +00:00

(Migrated from gitea.com)

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

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: lunny/helm-chart#328