Quick Build - commoncriteria/pp-template GitHub Wiki

To provide authors quicker and better feedback on the CI/CD github workflows, a new workflow has been created: The "Quick_Build" workflow. The QuickBuild workflow is a work in progress, so there might be mistakes and fixes in the future.

Steps:

gh-pages

QuickBuild requires that your project's gh-pages is turned on. To do this open your project's "Settings" and select "Pages" from the menu on the left. Make sure that the "Source" branch is set to "gh-pages". If you don't see a "gh-pages" option, you'll have to make this branch. Make a fresh clone of your project

git clone [email protected]/commoncriteria/<project-name>

And then run the following script:

git checkout --orphan gh-pages
git reset --hard
git commit --allow-empty -m "Initializing gh-pages branch"
git push origin gh-pages
git checkout master

Then delete this copy of the project.

Workflow

Now that you have your new branch, you can get the QuickBuild workflow. The easiest ways is probably to save the Application PP QuickBuild workflow into your project's .github/workflow directory. After this you can click on your projects "Actions" tab and see QuickBuild in action.

README

Now that your project has a QuickBuild Github Action it's time to show off the outputs. The best place is probably in your project's README file. The easiest way to do this is probably by copying the chunk of lines in the Application PP's README that are after the title and tailoring them to fit your project (i.e. Replace all instances of 'application' with your project's name).