razinbouzar opened a new pull request, #27:
URL: https://github.com/apache/druid-operator/pull/27
# Clean gh-pages branch for Helm chart repository
## Summary
This PR cleans the `gh-pages` branch so it can be used only as the published
Helm chart repository for Apache Druid Operator.
The branch currently contains source-tree files that were accidentally
merged into `gh-pages`. This change removes those files and leaves a
Helm-compatible empty repository index:
```text
index.yaml
```
After the publishing workflow runs, the expected branch layout will be:
```text
index.yaml
helm-releases/
druid-operator-<chart-version>.tgz
```
## Merge Order
Do not merge this PR until https://github.com/apache/druid-operator/pull/26
has merged.
PR #26 adds the Helm chart publishing workflow and ASF GitHub Pages
configuration on `master`. This cleanup PR only prepares the `gh-pages` branch
to host generated Helm repository content.
## Why
`gh-pages` should not contain the source repository. It should only contain
static files served by GitHub Pages. For the Helm chart repository, that means:
- `index.yaml`
- packaged chart archives under `helm-releases/`
Keeping `gh-pages` minimal avoids serving unrelated source files and gives
the publishing workflow a clean target branch.
## Validation
The resulting branch tree contains only:
```text
index.yaml
```
The `index.yaml` file was generated with Helm from an empty repository and
is valid as an initial Helm repository index:
```yaml
apiVersion: v1
entries: {}
generated: "<timestamp>"
```
## Follow-up
After PR #26 and this PR both merge, run the manual `Helm Chart` workflow
from `master` with `publish=true`. That workflow will:
1. package the chart
2. copy it to `gh-pages/helm-releases/`
3. regenerate `gh-pages/index.yaml`
4. push the published Helm repository content back to `gh-pages`
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<!-- Thanks for trying to help us make Druid Operator be the best it can be!
Please fill out as much of the following information as is possible (where
relevant, and remove it when irrelevant) to help make the intention and scope
of this PR clear in order to ease review. -->
Fixes #XXXX.
<!-- Replace XXXX with the id of the issue fixed in this PR. Remove this
section if there is no corresponding issue. Don't reference the issue in the
title of this pull-request. -->
### Description
<!-- Describe the goal of this PR and the problem you encoutered while
managing Druid clusters. Something like, "I have a Druid cluster managed with
this operator and wanted to change XX on the cluster to enable YY usecase that
I needed due to ZZ requirement.". If there is a corresponding issue (referenced
above), it's not necessary to repeat the description here, however, you may
choose to keep one summary sentence. -->
<!-- Describe the possible solutions and chosen one with the rationale. -->
<!-- Describe key changes made in the patch. -->
<hr>
This PR has:
- [ ] been tested on a real K8S cluster to ensure creation of a brand new
Druid cluster works.
- [ ] been tested for backward compatibility on a real K*S cluster by
applying the changes introduced here on an existing Druid cluster. If there are
any backward incompatible changes then they have been noted in the PR
description.
- [ ] added comments explaining the "why" and the intent of the code
wherever would not be obvious for an unfamiliar reader.
- [ ] added documentation for new or modified features or behaviors.
<hr>
##### Key changed/added files in this PR
* `MyFoo`
* `OurBar`
* `TheirBaz`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
