Using Github actions at the moment to run build, test and quality tasks.
These generally execute on push to to main or on pull-requests.
So if you want to test stuff in Github without pushing to main;
work in your own branch, create a PR and it will run the build and tests.
Note that changes consisting solely of *.md files are intended to be ignored.
-
- builds and runs unit and integration tests
-
- does a production build of the app-client
-
- runs an api-svc build in the context of Github codeql
-
Look in Github Actions console to see what's going on
Information about how the ARDC RAiD service is run and operated can be found in operational-environment.md.
If you're intending run your own RAiD service as a registration-agency, you can follow that documentation, in conjunction with adapting the AWS CDK code to your own environment.
You can request access to the private repository that contains the CDK code by
emailing the team at [email protected].
Pre-requisites and instructions for local development
See /doc/code - there may also be further sub-project
specific standards local to that project, look in the local /doc directory.
AWS build and deployment is automated via AWS CodeBuild projects - see deployment-environment.md
Use the codebuild projects to point you in the direction of the build tasks
that you need. Check for any readme.me files or /doc directories nearby
the component of interest - they should contain further and more detailed
instructions for building/running the software.
See build-troubleshooting.md if having issues.
Currently daily development, CI and DEMO builds and releases are all
done using the main branch.
Currently PROD is deployed from the v1.2 branch, this approach is likely to
continue with future versions.
Releases are tracked and built using git describe functionality working off
of annotated tags with the prefix raido-v-.