2c1fc4b500
This PR introduces two new server configuration options, for providing a custom .JS and .CSS file. These can be used to show custom banner messages, add environment-dependent signals, or simply a corporate logo. ### Motivation (what problem I try to solve) I'm operating Woodpecker in multiple k8s clusters for different environments. When having multiple browser tabs open, I prefer strong indicators for each environment. E.g. a red "PROD" banner, or just a blue "QA" banner. Also, we sometimes need to have the chance for maintenance, and instead of broadcasting emails, I prefer a banner message, stating something like: "Heads-up: there's a planned downtime, next Friday, blabla...". Also, I like to have the firm's logo visible, which makes Woodpecker look more like an integral part of our platform. ### Implementation notes * Two new config options are introduced ```WOODPECKER_CUSTOM_CSS_FILE``` and ```WOODPECKER_CUSTOM_JS_FILE``` * I've piggy-bagged the existing handler for assets, as it seemed to me a minimally invasive approach * the option along with an example is documented * a simple unit test for the Gin-handler ensures some regression safety * no extra dependencies are introduced ### Visual example The documented example will look like this.  ### Areas of uncertainty This is my first contribution to Woodpecker and I tried my best to align with your conventions. That said, I found myself uncertain about these things and would be glad about getting feedback. * The handler tests are somewhat different than the other ones because I wanted to keep them simple - I hope that still matches your coding guidelines * caching the page sometimes will let the browser not recognize changes and a user must reload. I'm not fully into the details of how caching is implemented and neither can judge if it's a real problem. Another pair of eyes would be good. |
||
|---|---|---|
| .github | ||
| .vscode | ||
| .woodpecker | ||
| agent | ||
| cli | ||
| cmd | ||
| contrib/woodpecker-test-repo/.woodpecker | ||
| docker | ||
| docs | ||
| nfpm | ||
| pipeline | ||
| server | ||
| shared | ||
| version | ||
| web | ||
| woodpecker-go | ||
| .changelog.yml | ||
| .ecrc | ||
| .editorconfig | ||
| .gitignore | ||
| .gitpod.yml | ||
| .golangci.yml | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| docker-compose.example.yml | ||
| docker-compose.gitpod.yml | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| SECURITY.md | ||
Woodpecker
Woodpecker is a community fork of the Drone CI system.
🫶 Support
Please consider to donate and become a backer. 🙏 [Become a backer]
🚀 Usage
.woodpecker.yml
- Place your pipeline in a file named
.woodpecker.ymlin your repository - Pipeline steps can be named as you like
- Run any command in the commands section
Build steps are containers
- Define any Docker image as context
- Install the needed tools in custom Docker images, use them as context
Plugins
Woodpecker has official plugins, but you can also use your own.
📖 Documentation
✨ Contribute
📣 Translate
We use an own Weblate instance at translate.woodpecker-ci.org.
👋 Who uses Woodpecker?
Codeberg, the Woodpecker project itself, and many others.
Leave a comment if you're using it as well.
Also consider using the topic WoodpeckerCI in your repository, so others can learn from your config and use the hashtag #WoodpeckerCI when talking about the project on social media!
Here are some places where people mention Woodpecker:
✨ Stars over time
License
Woodpecker is Apache 2.0 licensed with the source files in this repository having a header indicating which license they are under and what copyrights apply.
Files under the docs/ folder are licensed under Creative Commons Attribution-ShareAlike 4.0 International Public License.