Codeberg Documentation

Getting Started with Codeberg
What is Codeberg? Your First Steps on Codeberg Install Git Your First Repository The Basics of Issue Tracking Integrated Wiki Email Settings Licensing on Codeberg Frequently Asked Questions
Collaborating with Others
Citable Code Pull requests and Git flow Invite Collaborators Create and Manage an Organization Repository Permissions Resolve Conflicts
Working with Git Repositories
Configuring Git Using .gitignore Clone & Commit via CLI Clone & Commit via Web Merge multiple commits into one Tags and Releases Working with large files
Writing in Markdown
Introduction to Markdown Using Links Topics Preformatted Text Using Images Using Lists Tables in Markdown Markdown FAQ
Security
Setting up two-factor authentication Adding an SSH key to your account Verifying you're connected to Codeberg using SSH fingerprints Adding a GPG key to your account
Codeberg Pages
Using Custom Domains Troubleshooting Example: Docs as Code with Sphinx Pushing output from SSGs into Codeberg Pages Redirects
Working with Codeberg's CI

Advanced Usage
Migrating Repositories Using Webhooks Generating an Access Token
Integrations with Other Services
Integrating with Keycloak Integrating with Matrix Integrating with Read the Docs
Codeberg Translate
Getting started Introduction to Weblate Manual Component configuration
Improving Codeberg
Contributing Code
Improving the Documentation
Style Guide How to create a new article? Can I preview my article? How to make screenshots for Codeberg Documentation? Documentation Contributor FAQ
Contact

Working with Codeberg's CI

Every piece of code should be tested regularly. Ideally developers already implement unit-tests to test the functionality of code sections. Some projects even implement a suite of integration tests, testing whether the code in different parts of the software works as a whole and (still) provides the functionality the software promises to deliver. Running these tests regularly (or continuously) is the job of a Continuous Integration solution. The results of the tests are displayed to the project members and maintainers, enabling them to identify problems and react if errors occur.

Using Codeberg's instance of Woodpecker CI

Codeberg currently provides an instance of Woodpecker CI to everyone who needs it. You need to request access, because we want to keep resource abuse minimal. Please check out our request procedure!

For the usage of our Woodpecker instance, keep the following in mind:

  • CI access is provided as-is and might break at any time and for an undefined period of time, due to server issues, for testing and maintenance purpose or human error. Our CI service is not of the highest priority right now.
  • Resource usage must be reasonable for the intended use-case. This is determined on a case-by-case basis, but please be aware that CI uses a lot of computing resources (cloning your repo and container, installing all your required tools, building and throwing every thing away) which costs us money and does damage to our precious environment. Therefore, please consider twice how to create a good balance between ensuring code quality for your project and resource usage therefore.
  • The service is in an early phase, which means it might not yet be suited for large and complex projects. Please report all issues you face to us, so you can be a part of the improvement!

If you are just curious about Woodpecker or already got access to a Woodpecker instance, the Woodpecker project has a great documentation on how to use Woodpecker in your repositories. For now, refer to the Gitea VCS integration section.

Using Codeberg / Forgejo / Gitea Actions

Recently, a GitHub-Actions-compatible feature has been integrated in Forgejo, the software Codeberg uses.

Due to outstanding security issues and bus factor (we need more maintainers for our CI service to get it running), we are currently not yet providing hosted Actions. If you need Codeberg to host your CI, please use Woodpecker CI instead.

But you can already connect your own runner to Codeberg. CI jobs will run on your machine, and the result will be displayed in Codeberg.

Further information is available in the

Hey there! 👋 Thank you for reading this article!

Is there something missing, or do you have an idea on how to improve the documentation? Do you want to write your own article?

You're invited to contribute to the Codeberg Documentation at its source code repository, for example, by adding a pull request or joining in on the discussion in the issue tracker.

For an introduction on contributing to Codeberg Documentation, please have a look at the Contributor FAQ.

© Codeberg Docs Contributors. See LICENSE