Release Manager (Web Site)

Below are the required steps to publish an update to the Apache Royale website.

The Apache Royale production website is at the following URL:

https://royale.apache.org

The repository for the Apache Royale website is at the following URL:

https://github.com/apache/royale-website

The Royale production website is a static site, meaning that its content is plain HTML and CSS, and nothing is generated dynamically on the server for incoming requests. Instead, the website is built from Markdown files committed to the website's repository, and the generated HTML files are uploaded to Apache's servers. New commits to the repository are automatically detected by our CI server, which will build and deploy the site. We use an .asf.yaml file to configure Apache infrastructure.

The Eleventy static site generator is used to convert the website content from Markdown (and supporting templates/layouts) to a static HTML site. The development and build process for Eleventy runs on Node.js.

CI (Continuous Integration) is handled by Github Actions. You can see the results of recent and active builds of the royale-website repository here:

https://github.com/apache/royale-website/actions

Making changes to the website

Clone the royale-website repository:

git clone [email protected]:apache/royale-website.git

In the root of your local copy, install the required dependencies using npm.

cd royale-website
npm install

To start a local server for development, run the following command:

npm start

The output of this command will include the local URL that you can open in a web browser to view your changes. It is usually here:

http://localhost:8080

While the development server is still running, any changes to the Markdown files will be detected automatically, and your browser should automatically reload to display them. There's no need to build the full website locally because the local development server does it in real time.

When you are happy with your changes, commit them and push. The CI server should automatically build the site and deploy a new version within a few minutes.

git commit -m "A description of your changes"
git push origin master

Notes

The following URLs must always be HTTP instead of HTTPS:

• http://apacheroyaleci2.westus2.cloudapp.azure.com:8080/job/royale-asjs/lastSuccessfulBuild/artifact/out/
• http://apacheroyaleci2.westus2.cloudapp.azure.com:8080/job/royale-asjs_jsonly/lastSuccessfulBuild/artifact/out/
• http://apache-royale-users.20374.n8.nabble.com/
• http://apache-royale-development.20373.n8.nabble.com/
• http://ns.adobe.com/mxml/2009