Official Selenium website and documentation
This is the repository used to build and publish the official Selenium website.
We use Hugo to build and render the site and docs, which are two separate Hugo projects.
After cloning the repository, if you want to make changes to the site, work on the
site_source_filesdirectory. To make changes to the docs, switch to the
docs_source_filesdirectory. To see a live preview of your changes, run
hugo serveron each directory.
% cd site_source_files/docs_source_files % hugo server
A full contribution guideline can be seen at contributing
Please check all the information available at https://selenium.dev/getinvolved/
GitHub actions runs for every commit on each PR and protected branch. The regular CI execution will just build the site with Hugo to verify that the commit works. The description of these steps can be seen at the actions configuration file, one for testing a PR, and one for deploying the site
After each CI execution that happens in the
devbranch, the script build-site.sh is executed for deployment. This script checks for the string
[deploy site]in the commit message.
If the commit message contains that string, and the commit is in
dev, a GitHub action is triggered to build and deploy the site. The site and docs will be built, and the changes will be committed to the branch
publishby the user Selenium-CI.
What is important to take into account is that the source files for the site are in the
devbranch, and the files that get deployed are pushed to the
The site and docs are deployed using GitHub pages, and the configuration for this can be seen at the repo settings (if you are a maintainer you should be able to access the link).
If for any reason, you need to setup the domain redirection again, we followed this guide, but any tutorial/guide showing how to redirect a domain to GitHub pages should do.
Files are living under websitehugofiles.
Steps needed to have this working locally and work on it:
git submodule update --init --recursive