Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Cookiecutter Component Template #72

Closed
7 tasks done
srueg opened this issue Apr 7, 2020 · 6 comments
Closed
7 tasks done

Update Cookiecutter Component Template #72

srueg opened this issue Apr 7, 2020 · 6 comments
Assignees
@corvus-ch
Labels
enhancement New feature or request

Comments

@srueg
Copy link
Contributor

srueg commented Apr 7, 2020 •
edited by corvus-ch
Loading

Update the Cookiecutter template for new components to include the following:

  • A license: BSD-3-Clause
  • Option to base a component on a Helm chart (i.e. --helm) -> see Option to base a component on a Helm chart #118.
  • Add GitHub actions (jsonnet & yaml lint, others tbd)
  • doc/ subfolder?
  • README.adoc template
  • CHANGELOG.adoc template
  • GitHub templates

How does the release process look like? Keyword: Changelog?

  • Release process automation
  • GitHub release preparation
@srueg srueg added the enhancement New feature or request label Apr 7, 2020
@tobru
Copy link
Contributor

tobru commented Jun 11, 2020

@corvus-ch Please do a real life experiment with appuio/component-openshift4-authentication#5

@corvus-ch
Copy link
Contributor

The example in the openshift4-oauth component is done. It can be included in the cookiecutter.

Thoughts on how to improve:

GitHub strongly suggests to have a CONTRIBUTING.md file within each repository. For components we would (ideally) have the same file in each and every component repository. Instead of keeping them all in sync, we might opt to move that to somewhere at syn.tools and just place a link into CONTRIBUTING.md.

@corvus-ch corvus-ch mentioned this issue Jun 17, 2020
Merged
@corvus-ch
Copy link
Contributor

@srueg Can we extract the option to base a component on a Helm chart to an issue on its own?

@srueg
Copy link
Contributor Author

srueg commented Jun 17, 2020

Sure 👍

@corvus-ch
Copy link
Contributor

In addition, also a code of conduct got added to the template.

I do not yet have an answer on how to do release automation.

@tobru
Copy link
Contributor

tobru commented Jun 19, 2020

Done in #117

@tobru tobru closed this as completed Jun 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@corvus-ch corvus-ch

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@corvus-ch @srueg @tobru