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.

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

Add a comment-like entry in projects.json #577

Merged
merged 2 commits into from
Jan 14, 2024

Conversation

aliok
Copy link
Member

@aliok aliok commented Jan 12, 2024

Fixes #574

Although this is not an ideal solution, since we can't add a comment to a JSON file, I've modified the Python script to add an entry at the top that looks like a comment. See projects.json in the changed files.

That entry is ignored in the https://contribute.cncf.io/contributors/projects/ page as the project (graduation level) doesn't match anything.

https://deploy-preview-577--cncf-contribute.netlify.app/contributors/projects/ still works fine and is not affected.

The only problem that can happen is that if there are any people who fetch this file for their own purposes. In that case, they would have to adapt their automation.

@aliok aliok force-pushed the 2024-01-13-comment-in-projects-json-file branch from 9bc18eb to 48d7395 Compare January 12, 2024 22:27
@aliok aliok requested a review from cjyabraham January 12, 2024 22:30
Copy link
Contributor

@cjyabraham cjyabraham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like a good solution!

@aliok aliok merged commit d43866c into cncf:main Jan 14, 2024
1 check passed
@aliok aliok deleted the 2024-01-13-comment-in-projects-json-file branch January 14, 2024 11:03
@geekygirldawn
Copy link
Member

This is great, thanks! I've worked mostly with YAML files, and I had no idea until now that comments weren't supported within JSON files!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

Projects.json
3 participants