feat: Rename Gitea to Forgejo in docs and document it#2420
feat: Rename Gitea to Forgejo in docs and document it#2420chmouel merged 2 commits intotektoncd:mainfrom
Conversation
🔍 PR Lint Feedback
|
Summary of ChangesHello @chmouel, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request integrates Forgejo as a supported Git provider within Pipelines-as-Code, enhancing its compatibility with community-driven Git forge solutions. The changes primarily involve updating and adding documentation to guide users through the setup and configuration of Forgejo, ensuring a seamless experience for leveraging Pipelines-as-Code with Forgejo repositories. While the external facing documentation now highlights Forgejo, the underlying provider type in configurations remains 'gitea' due to API compatibility. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request does a great job of renaming Gitea to Forgejo throughout the documentation and adding a new, detailed installation guide for Forgejo. The changes are consistent and align with the goal of supporting Forgejo. I've identified a couple of minor areas for improvement in the new documentation file to enhance clarity and correctness for users.
docs/content/docs/install/forgejo.md
Outdated
| Update the secret: | ||
|
|
||
| ```shell | ||
| kubectl -n $target_namespace patch secret forgejo-webhook-config -p "{\"data\": {\"provider.token\": \"$(echo -n $NEW_TOKEN|base64 -w0)\"}}" |
There was a problem hiding this comment.
The variable $target_namespace is used here but is not defined in the preceding code snippets. To ensure consistency with other commands in this guide (e.g., on lines 89 and 97), it would be clearer to use the literal string target-namespace.
| kubectl -n $target_namespace patch secret forgejo-webhook-config -p "{\"data\": {\"provider.token\": \"$(echo -n $NEW_TOKEN|base64 -w0)\"}}" | |
| kubectl -n target-namespace patch secret forgejo-webhook-config -p "{\"data\": {\"provider.token\": \"$(echo -n $NEW_TOKEN|base64 -w0)\"}}" |
There was a problem hiding this comment.
Pull request overview
This PR updates the Pipelines-as-Code documentation to reflect Forgejo support as a Tech Preview. Forgejo is a community-driven fork of Gitea that maintains API compatibility with Gitea. The internal provider type remains "gitea" for compatibility, but user-facing documentation now refers to Forgejo.
Changes:
- Added comprehensive Forgejo installation guide with webhook setup instructions
- Updated all documentation references from "Gitea" to "Forgejo" in user-facing text
- Modified the support matrix shortcode to use "forgejo" parameter instead of "gitea"
- Adjusted documentation weights to properly order Forgejo between GitLab and Bitbucket
Reviewed changes
Copilot reviewed 12 out of 13 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/layouts/shortcodes/support_matrix.html | Updated shortcode parameter from gitea to forgejo and changed display text to "Forgejo" |
| docs/content/docs/install/settings.md | Updated documentation text to mention Forgejo instead of Gitea |
| docs/content/docs/install/global_repositories_setting.md | Added clarification that "gitea" provider type is used for Forgejo |
| docs/content/docs/install/forgejo.md | New comprehensive installation guide for Forgejo webhook setup |
| docs/content/docs/install/bitbucket_datacenter.md | Adjusted weight from 15 to 16 to accommodate new Forgejo doc |
| docs/content/docs/install/bitbucket_cloud.md | Adjusted weight from 14 to 15 to accommodate new Forgejo doc |
| docs/content/docs/guide/running.md | Updated support matrix calls to use "forgejo" parameter |
| docs/content/docs/guide/policy.md | Updated documentation text and support matrix to reference Forgejo |
| docs/content/docs/guide/matchingevents.md | Updated support matrix calls and text references to use Forgejo |
| docs/content/docs/guide/gitops_commands.md | Updated support matrix calls to use "forgejo" parameter |
| docs/content/docs/dev/_index.md | Updated developer documentation with Forgejo examples and terminology |
| README.md | Updated main README to list Forgejo instead of Gitea in supported providers |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| $forgejoSupported := .Get "forgejo" }} {{ $gitlabSupported := .Get "gitlab" }} {{ | ||
| $bitbucketCloudSupported := .Get "bitbucket_cloud" }} {{ |
There was a problem hiding this comment.
Duplicate variable declaration: $gitlabSupported is declared twice (lines 1 and 3). The first declaration on line 1 will be overwritten by the second declaration on line 3. Remove the duplicate declaration on line 3 to avoid confusion and potential issues.
| $forgejoSupported := .Get "forgejo" }} {{ $gitlabSupported := .Get "gitlab" }} {{ | |
| $bitbucketCloudSupported := .Get "bitbucket_cloud" }} {{ | |
| $forgejoSupported := .Get "forgejo" }} {{ $bitbucketCloudSupported := .Get "bitbucket_cloud" }} {{ |
Added documentation and configuration details for integrating with Forgejo, a community-driven Git forge. This includes a new installation guide for Forgejo, updates to existing documentation to reflect Forgejo support, and modifications to the support matrix shortcode to include Forgejo. The changes ensure that users can now leverage Pipelines-as-Code with Forgejo repositories. We still have the providers and internals as Gitea for now to don't make this too much of a change. Jira: https://issues.redhat.com/browse/SRVKP-9993 Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
d707a6a to
d355af7
Compare
| $forgejoSupported := .Get "forgejo" }} {{ $gitlabSupported := .Get "gitlab" }} {{ | ||
| $bitbucketCloudSupported := .Get "bitbucket_cloud" }} {{ |
| token: "your token has generated in gitea" | ||
| webhook: "" # make sure it's empty when you set this up on the interface and here | ||
| token: "your token generated in Forgejo" | ||
| webhook: "" # Forgejo allows empty webhook secrets |
There was a problem hiding this comment.
this is going to be fixed in another pull requesst
|
|
||
| There are some gotchas with the webhook validation secret. Pipelines-as-Code | ||
| detects a Gitea install and lets the user set an empty webhook secret (by default | ||
| detects a Forgejo install and lets the user set an empty webhook secret (by default |
| - github | ||
| - gitlab | ||
| - gitea | ||
| - gitea (used as well for Forgejo) |
There was a problem hiding this comment.
By keeping the provider as gitea, are we subtly telling users that they can run on gitea (given the API compatibility)?
Or would we change this in the future?
There was a problem hiding this comment.
it's planned to be moved to forgejo just step by step....
|
Also found gitea headers usage in the CLI here. Are they the same in forgejo? |
ah yes right! yes they are all avaialble even X-Gogs headers are there which is the orginal one... will create an issue tho just in case for the future |
|
❌ PR-Agent failed to apply 'global' repo settings The configuration file needs to be a valid TOML, please fix it. Error message: Configuration content:[github_app]
pr_commands = [ "/review" ]
[pr_reviewer]
enable_review_labels_security = true
enable_chat_in_code_suggestions=false
enable_chat_in_code_suggestions = false
enable_summary=false
enable_help_text=false
[pr_description]
publish_description_as_comment = true
[pr_code_suggestions]
commitable_code_suggestions = true
[pr_test]
num_tests = 0 |
📝 Description of the Change
Added documentation and configuration details for integrating with Forgejo, a community-driven Git forge. This includes a new installation guide for Forgejo, updates to existing documentation to reflect Forgejo support, and modifications to the support matrix shortcode to include Forgejo. The changes ensure that users can now leverage Pipelines-as-Code with Forgejo repositories.
We still have the providers and internals as Gitea for now to don't make this too much of a change.
👨🏻 Linked Jira
https://issues.redhat.com/browse/SRVKP-9993
🔗 Linked GitHub Issue
Fixes #
🚀 Type of Change
fix:)feat:)feat!:,fix!:)docs:)chore:)refactor:)enhance:)deps:)🧪 Testing Strategy
🤖 AI Assistance
If you have used AI assistance, please provide the following details:
Which LLM was used?
Extent of AI Assistance:
Important
If the majority of the code in this PR was generated by an AI, please add a
Co-authored-bytrailer to your commit message.For example:
Co-authored-by: Gemini gemini@google.com
Co-authored-by: ChatGPT noreply@chatgpt.com
Co-authored-by: Claude noreply@anthropic.com
Co-authored-by: Cursor noreply@cursor.com
Co-authored-by: Copilot Copilot@users.noreply.github.com
**💡You can use the script
./hack/add-llm-coauthor.shto automatically addthese co-author trailers to your commits.
✅ Submitter Checklist
fix:,feat:) matches the "Type of Change" I selected above.make testandmake lintlocally to check for and fix anyissues. For an efficient workflow, I have considered installing
pre-commit and running
pre-commit installtoautomate these checks.