Skip to content

Commit

Permalink
docs(common): link "Release Process"-wiki page to the contribution rules
Browse files Browse the repository at this point in the history
(#867)

* docs(common): optimize comment/uncomment doing (#867)
  • Loading branch information
khauser committed Jan 9, 2025
1 parent 34177c9 commit cc3c20b
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 51 deletions.
14 changes: 10 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,18 @@ If you have any questions feel free to also send them to this email address.
## Contribution process

1. Fork the repository
2. Use the `main` branch for your edits
2. Use the appropriate `develop\?` branch as base for your feature branch. See [Release Process](https://github.com/intershop/helm-charts/wiki/Release-Process)
3. Work on changes
4. Comment the changes
5. Check whether the changes comply with the the rules (design etc.)
6. Create a pull request
6. Commit changes according to our Commit Message Guidelines
6. Create a pull request into the `develop\?` base branch
7. Add as much information as needed
8. Reference the solved issue
9. Wait for the review
10. PR is approved, denied (with explanation) or sent back for further information
11. We are trying to react as fast as possible to pull-request, issues, feedback and any other community interaction. However, we can’t guarantee a particular timeframe for every answer. We hope you understand and apologize for any inconveniences.
12. If PR is approved the changes shall be merged via squash commit to improve commit history readability

## Commit Message Guidelines

Expand All @@ -48,6 +50,10 @@ Some rules to be emphasized for chart related commits:
* A commit message starting with `feat(icm):` (or e.g.: `feat(pwa):`) will get a _MINOR_ change.
* The rest will be _PATCH_.

Chart unreleated commits (like e.g. docs, chore, build, test) will not be taken into account but still should be conventional and informative as possible.
Please also enhance your commit message with an existing **github issue number**, where detailed information could be found. Github will later on link the commit to the issue ticket automatically.

All of this will help to read and interpret our changlogs and release notes.
Here is a sample commit message: `feat(icm): my short commit description (#123)`

Chart unrelated commits (like e.g. docs, chore, build, test) will not be taken into account but still should be conventional and informative as possible.

All of this will help to read and interpret our changlogs and release notes.
50 changes: 25 additions & 25 deletions charts/icm-as/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -337,13 +337,13 @@ persistence:
# Probes, all values are optional, below are the defaults
probes:
startup: {}
# failureThreshold: 6
# initialDelaySeconds: 60
# periodSeconds: 10
# failureThreshold: 6
# initialDelaySeconds: 60
# periodSeconds: 10
liveness: {}
# failureThreshold: 3
# initialDelaySeconds: 0
# periodSeconds: 10
# failureThreshold: 3
# initialDelaySeconds: 0
# periodSeconds: 10
readiness: {}
# failureThreshold: 3
# initialDelaySeconds: 0
Expand Down Expand Up @@ -527,27 +527,27 @@ replication:
# The following "source" and "targets" configuration blocks take precedence over
# the deprecated "targetSystemUrl" / "sourceDatabaseName" configurations
# Configuration for source system that participates in replication
# source:
# the external URL of the webServer/proxy/ingress e.g. https://icm-web-edit-wa:443
# webserverUrl: <sourceExternalUrl>
# either mutual exclusive databaseUser or databaseLink have to be configured
# databaseLink: <sourceDatabaseLink>
# databaseUser: <sourceDatabaseUser>
# databaseName: <sourceDatabaseName>
# source:
# # the external URL of the webServer/proxy/ingress e.g. https://icm-web-edit-wa:443
# webserverUrl: <sourceExternalUrl>
# # either mutual exclusive databaseUser or databaseLink have to be configured
# databaseLink: <sourceDatabaseLink>
# databaseUser: <sourceDatabaseUser>
# databaseName: <sourceDatabaseName>

# Configuration for all target systems that participates in replication
# targets:
# create multiple target systems - please avoid characters like '.', '-' or '_' in the chosen name/key
# live1:
# the external URL of the webServer/proxy/ingress e.g. https://icm-web-live-wa:443
# webserverUrl: <targetExternalUrl>
# this database user will be granted access to the database schema of the source replication system
# databaseUser: <targetDatabaseUser>
# live2:
# the external URL of the webServer/proxy/ingress e.g. https://icm-web-live-wa:443
# webserverUrl: <targetExternalUrl>
# this database user will be granted access to the database schema of the source replication system
# databaseUser: <targetDatabaseUser>
# targets:
# # create multiple target systems - please avoid characters like '.', '-' or '_' in the chosen name/key
# live1:
# # the external URL of the webServer/proxy/ingress e.g. https://icm-web-live-wa:443
# webserverUrl: <targetExternalUrl>
# # this database user will be granted access to the database schema of the source replication system
# databaseUser: <targetDatabaseUser>
# live2:
# # the external URL of the webServer/proxy/ingress e.g. https://icm-web-live-wa:443
# webserverUrl: <targetExternalUrl>
# # this database user will be granted access to the database schema of the source replication system
# databaseUser: <targetDatabaseUser>

# Configuration of messaging via jgroups
jgroups:
Expand Down
2 changes: 1 addition & 1 deletion charts/icm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Prerequisites are:
* [helm-unittest](https://github.com/helm-unittest/helm-unittest)

```bash
helm unittest --helm3 --output-file unit.xml --output-type JUnit charts/icm
helm unittest --output-file unit.xml --output-type JUnit charts/icm
```

### ct lint & install
Expand Down
42 changes: 21 additions & 21 deletions charts/icm/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ icm-as:
"cluster-autoscaler.kubernetes.io/safe-to-evict": "false"

image:
# repository: intershophub/icm-as
# tag: :11.0.12-dev1
# repository: intershophub/icm-as
# tag: :11.0.12-dev1

## define a secret for a container registry
dockerSecret:
Expand Down Expand Up @@ -75,27 +75,27 @@ icm-as:
# The following "source" and "targets" configuration blocks take precedence over
# the deprecated "targetSystemUrl" / "sourceDatabaseName" configurations
# Configuration for source system that participates in replication
# source:
# the external URL of the webServer/proxy/ingress e.g. https://icm-web-edit-wa:443
# webserverUrl: <sourceExternalUrl>
# either mutual exclusive databaseUser or databaseLink have to be configured
# databaseLink: <sourceDatabaseLink>
# databaseUser: <sourceDatabaseUser>
# databaseName: <sourceDatabaseName>
# source:
# # the external URL of the webServer/proxy/ingress e.g. https://icm-web-edit-wa:443
# webserverUrl: <sourceExternalUrl>
# # either mutual exclusive databaseUser or databaseLink have to be configured
# databaseLink: <sourceDatabaseLink>
# databaseUser: <sourceDatabaseUser>
# databaseName: <sourceDatabaseName>

# Configuration for all target systems that participates in replication
# targets:
# create multiple target systems - please avoid characters like '.', '-' or '_' in the chosen name/key
# live1:
# the external URL of the webServer/proxy/ingress e.g. https://icm-web-live-wa:443
# webserverUrl: <targetExternalUrl>
# this database user will be granted access to the database schema of the source replication system
# databaseUser: <targetDatabaseUser>
# live2:
# the external URL of the webServer/proxy/ingress e.g. https://icm-web-live-wa:443
# webserverUrl: <targetExternalUrl>
# this database user will be granted access to the database schema of the source replication system
# databaseUser: <targetDatabaseUser>
# targets:
# # create multiple target systems - please avoid characters like '.', '-' or '_' in the chosen name/key
# live1:
# # the external URL of the webServer/proxy/ingress e.g. https://icm-web-live-wa:443
# webserverUrl: <targetExternalUrl>
# # this database user will be granted access to the database schema of the source replication system
# databaseUser: <targetDatabaseUser>
# live2:
# # the external URL of the webServer/proxy/ingress e.g. https://icm-web-live-wa:443
# webserverUrl: <targetExternalUrl>
# # this database user will be granted access to the database schema of the source replication system
# databaseUser: <targetDatabaseUser>

icm-web:
enabled: true
Expand Down

0 comments on commit cc3c20b

Please sign in to comment.