Skip to content

feat: Rename Gitea to Forgejo in docs and document it#2420

Merged
chmouel merged 2 commits intotektoncd:mainfrom
chmouel:srvkp-9993-add-forgejo-docs
Jan 30, 2026
Merged

feat: Rename Gitea to Forgejo in docs and document it#2420
chmouel merged 2 commits intotektoncd:mainfrom
chmouel:srvkp-9993-add-forgejo-docs

Conversation

@chmouel
Copy link
Copy Markdown
Member

@chmouel chmouel commented Jan 28, 2026

📝 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

  • 🐛 Bug fix (fix:)
  • ✨ New feature (feat:)
  • 💥 Breaking change (feat!:, fix!:)
  • 📚 Documentation update (docs:)
  • ⚙️ Chore (chore:)
  • 💅 Refactor (refactor:)
  • 🔧 Enhancement (enhance:)
  • 📦 Dependency update (deps:)

🧪 Testing Strategy

  • Unit tests
  • Integration tests
  • End-to-end tests
  • Manual testing
  • Not Applicable

🤖 AI Assistance

  • I have not used any AI assistance for this PR.
  • I have used AI assistance for this PR.

If you have used AI assistance, please provide the following details:

Which LLM was used?

  • GitHub Copilot
  • ChatGPT (OpenAI)
  • Claude (Anthropic)
  • Cursor
  • Gemini (Google)
  • Other: ____________

Extent of AI Assistance:

  • Documentation and research only
  • Unit tests or E2E tests only
  • Code generation (parts of the code)
  • Full code generation (most of the PR)
  • PR description and comments
  • Commit message(s)

Important

If the majority of the code in this PR was generated by an AI, please add a Co-authored-by trailer 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.sh to automatically add
these co-author trailers to your commits.

✅ Submitter Checklist

  • 📝 My commit messages are clear, informative, and follow the project's How to write a git commit message guide. The Gitlint linter ensures in CI it's properly validated
  • ✨ I have ensured my commit message prefix (e.g., fix:, feat:) matches the "Type of Change" I selected above.
  • ♽ I have run make test and make lint locally to check for and fix any
    issues. For an efficient workflow, I have considered installing
    pre-commit and running pre-commit install to
    automate these checks.
  • 📖 I have added or updated documentation for any user-facing changes.
  • 🧪 I have added sufficient unit tests for my code changes.
  • 🎁 I have added end-to-end tests where feasible. See README for more details.
  • 🔎 I have addressed any CI test flakiness or provided a clear reason to bypass it.
  • If adding a provider feature, I have filled in the following and updated the provider documentation:
    • GitHub App
    • GitHub Webhook
    • Gitea/Forgejo
    • GitLab
    • Bitbucket Cloud
    • Bitbucket Data Center

Copilot AI review requested due to automatic review settings January 28, 2026 10:39
@pipelines-as-code
Copy link
Copy Markdown

pipelines-as-code bot commented Jan 28, 2026

🔍 PR Lint Feedback

Note: This automated check helps ensure your PR follows our contribution guidelines.

⚠️ Items that need attention:

🤖 AI attribution

The following commits lack an explicit AI attribution footer:

  • d355af7 feat: Rename Gitea to Foregjo in docs

If no AI assistance was used for a commit, you can ignore this warning.
Otherwise add an Assisted-by: or Co-authored-by: footer referencing the AI used.


ℹ️ Next Steps

  • Review and address the items above
  • Push new commits to update this PR
  • This comment will be automatically updated when issues are resolved
🔧 Admin Tools (click to expand)

Automated Issue/Ticket Creation:

  • /issue-create - Generate a GitHub issue from this PR content using AI
  • /jira-create - Create a SRVKP Jira ticket from this PR content using AI

⚠️ Important: Always review and edit generated content before finalizing tickets/issues.
The AI-generated content should be used as a starting point and may need adjustments.

These commands are available to maintainers and will post the generated content as PR comments for review.

🤖 This feedback was generated automatically by the PR CI system

@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello @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

  • Forgejo Support: Pipelines-as-Code now officially supports Forgejo as a Git provider, marked as a Tech Preview feature. This expands the range of Git platforms compatible with the system.
  • Comprehensive Documentation: A new, detailed installation guide for Forgejo has been added, covering token creation, manual webhook configuration, and Kubernetes Secret/Repository CRD setup. All existing documentation references to Gitea have been updated to reflect Forgejo support.
  • Documentation Updates: The support_matrix shortcode and various guide documents (e.g., GitOps commands, matching events, policy, running pipelines) have been updated to include Forgejo, ensuring accurate compatibility information.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@pipelines-as-code pipelines-as-code bot added documentation Improvements or additions to documentation feature New feature or request providers labels Jan 28, 2026
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

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.

Update the secret:

```shell
kubectl -n $target_namespace patch secret forgejo-webhook-config -p "{\"data\": {\"provider.token\": \"$(echo -n $NEW_TOKEN|base64 -w0)\"}}"
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

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.

Suggested change
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)\"}}"

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

Comment on lines 3 to 4
$forgejoSupported := .Get "forgejo" }} {{ $gitlabSupported := .Get "gitlab" }} {{
$bitbucketCloudSupported := .Get "bitbucket_cloud" }} {{
Copy link

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
$forgejoSupported := .Get "forgejo" }} {{ $gitlabSupported := .Get "gitlab" }} {{
$bitbucketCloudSupported := .Get "bitbucket_cloud" }} {{
$forgejoSupported := .Get "forgejo" }} {{ $bitbucketCloudSupported := .Get "bitbucket_cloud" }} {{

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

good bot

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>
@chmouel chmouel force-pushed the srvkp-9993-add-forgejo-docs branch from d707a6a to d355af7 Compare January 28, 2026 12:47
Comment on lines 3 to 4
$forgejoSupported := .Get "forgejo" }} {{ $gitlabSupported := .Get "gitlab" }} {{
$bitbucketCloudSupported := .Get "bitbucket_cloud" }} {{
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

good bot

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
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

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
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

same

- github
- gitlab
- gitea
- gitea (used as well for Forgejo)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

it's planned to be moved to forgejo just step by step....

@theakshaypant
Copy link
Copy Markdown
Member

theakshaypant commented Jan 30, 2026

Also found gitea headers usage in the CLI here. Are they the same in forgejo?

@chmouel
Copy link
Copy Markdown
Member Author

chmouel commented Jan 30, 2026

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

@chmouel chmouel merged commit baf9c3c into tektoncd:main Jan 30, 2026
4 checks passed
@chmouel chmouel deleted the srvkp-9993-add-forgejo-docs branch January 30, 2026 08:24
@chmouel chmouel changed the title feat: Rename Gitea to Foregjo in docs and document it feat: Rename Gitea to Forgejo in docs and document it Feb 5, 2026
@qodo-code-review
Copy link
Copy Markdown

PR-Agent failed to apply 'global' repo settings

The configuration file needs to be a valid TOML, please fix it.


Error message:
cannot access local variable 'file_data' where it is not associated with a value

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation feature New feature or request providers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants