Merge pull request open-cluster-management-io#86 from haoqing0110/docs/improve-onboarding-and-changelog

🌱 Improve onboarding guide and fix changelog monorepo tag filtering

Author: haoqing0110

README.md

@@ -34,42 +34,53 @@ To onboard a new addon-contrib project:
 1. If not already discussed with maintainers, open an issue to propose your idea.
 1. Once acknowledged, create a folder named after your project and add your code/docs.
 1. Add an `OWNERS` file listing the new project's maintainers.
-1. Create a PR with a brief project overview and confirm the `OWNERS` file is present.
+1. **Register your project** in `.github/repositories.json` (see [Repository Registration](#repository-registration) below).
+1. **Ensure CI/CD compliance** by implementing required structure and targets (see [GitHub Actions Requirements](#github-actions-requirements) below).
+1. Create a PR with a brief project overview and confirm all requirements are met.
 1. An OCM maintainer will review and merge the PR.
 
-### GitHub Actions
+### GitHub Actions Requirements
 
 All projects must follow certain conventions to ensure compatibility with the addon-contrib repository's Github Actions workflows.
 
 Refer to the [Test](./.github/workflows/test.yml) and [E2E](./.github/workflows/e2e.yml) workflows for exact details.
 
-#### `make` targets
+#### Required `make` Targets
 
-All projects must define the following `make` targets:
+All projects **must** define the following `make` targets in their `Makefile`:
 
-- `verify`: Import statement formatting verification using `gci` and static code analysis and linting using `golangci-lint`
-- `build`: Compile the Go application into a statically linked binary with debug information stripped for optimal container deployment
-- `test-unit`: Invoke unit tests and return an exit code accordingly.
-- `test-chart`: Invoke scripts to verify your chart can be installed successfully.
-- `test-e2e`: Invoke end-to-end tests and return an exit code accordingly.
-- `image`: Build all container image.
-- `image-push`: Push all container images.
-- `image-manifest`: Create annotate and push multi-architecture manifests for all images.
+| Target | Description | Can be Stub? |
+|--------|-------------|--------------|
+| `verify` | Code verification (linting, formatting) | No - should run actual checks |
+| `vendor` | Update Go module dependencies | No - if Go project |
+| `build` | Build the application binary | No - if Go project |
+| `test-unit` | Run unit tests | No - should run actual tests |
+| `test-integration` | Run integration tests | **Yes** - can return true if not implemented |
+| `test-e2e` | Run end-to-end tests | **Yes** - can return true if not implemented |
+| `test-chart` | Test Helm chart installation | **Yes** - can return true if no chart |
+| `image` | Build container image | **Yes** - only if Dockerfile exists |
+| `image-push` | Push container image to registry | **Yes** - only if Dockerfile exists |
+| `image-manifest` | Create multi-arch image manifest | **Yes** - only if Dockerfile exists |
 
-#### Dockerfiles
+#### Dockerfiles (Optional)
 
-All Dockerfiles for the project must reside under `<project_name>/` and the default Dockerfile must be named `Dockerfile`.
+Container images are **optional**. If your addon requires a container image:
+
+- Dockerfile must reside under `<project_name>/Dockerfile`
+- The workflow will automatically detect Dockerfile presence
+- If no Dockerfile exists, image build steps will be skipped
 
 #### Helm Charts
 
-Any projects that require a Helm chart must be structured as follows:
+**If** your project requires a Helm chart, it must be structured as follows:
 
 ```bash
 <project_name>
 └── charts
-    └── <project_name> # chart name must match project directory name
+    └── <project_name>  # Chart name must match project directory name
         ├── Chart.yaml
         ├── templates
+        │   └── *.yaml
         └── values.yaml
 ```
 

hack/changelog.py

@@ -65,22 +65,35 @@ def section_if_present(changes: [], pr_title):
     repo = g.get_repo("open-cluster-management-io/addon-contrib")
     pulls = repo.get_pulls(state='closed', sort='created', base='main', direction='desc')
 
-    # get the last release tag
+    # get the last release tag for this specific sub repo
     tags = repo.get_tags()
     if tags.totalCount == 0:
         print("no tags in the repo")
         sys.exit()
-    elif tags.totalCount == 1:
-        last_release_tag = tags[0].name
+
+    # Filter tags that match the current repo_name prefix
+    # Use exact prefix match to avoid matching similar repo names
+    repo_tags = []
+    for tag in tags:
+        if tag.name.startswith(repo_name + '/'):
+            repo_tags.append(tag)
+
+    if len(repo_tags) <= 1:
+        # First release for this repo - no previous tags to compare
+        # (0 = not tagged yet, 1 = only current tag exists)
+        last_release_tag = None
     else:
-        last_release_tag = tags[1].name
+        # Find the previous release tag (second in the filtered list)
+        # repo_tags[0] is current release, repo_tags[1] is previous
+        last_release_tag = repo_tags[1].name
 
     # get related PR from the last release tag
     last_release_pr = 0
     release_word = "in"
 
-    if tags.totalCount > 1:
+    if last_release_tag:
         release_word = "since"
+        # Find the tag object to get its commit and associated PRs
         for tag in tags:
             if tag.name == last_release_tag:
                 tag_pulls = tag.commit.get_pulls()
@@ -116,8 +129,11 @@ def section_if_present(changes: [], pr_title):
 
     # Print
     print("# %s %s" % (repo_name, release_tag))
-    print("\n**changes %s [%s](https://github.com/open-cluster-management-io/releases/%s)**\n"
-          % (release_word, last_release_tag, last_release_tag))
+    if last_release_tag:
+        print("\n**changes %s [%s](https://github.com/open-cluster-management-io/releases/%s)**\n"
+              % (release_word, last_release_tag, last_release_tag))
+    else:
+        print("\n**Initial release**\n")
     section_if_present(breakings, ":warning: Breaking Changes")
     section_if_present(features, ":sparkles: New Features")
     section_if_present(bugs, ":bug: Bug Fixes")