Use The Source

Architecture

These are common design decisions for UseTheSource software in different stages of development. The decisions and the fact that they are shared among the projects is motivated by striving for continuity, integration and adoption.

Programming Languages, Frameworks and Platform

  • We try to avoid external dependencies, and use the JVM as much as possible;
  • External dependencies we resolve using the maven grand central (no embedded jars) or standard Eclipse update sites;
  • VScode is the default for IDE features
  • Next is Eclipse IDE features and UI integration.
  • We use HTML5 for visuals

Continuous Integration and Testing

  • We run all projects on the GitHub Actions instance;
  • Builds are triggered automatically after a push to GitHub.

Version Management

  • All projects use git;
  • All projects have main as the main development branch;
  • All projects are hosted on github in the usethesource organization;
  • All features are developed on a branch different from main (i.e. a pull request btanch);
  • A new main is pushed only if the unit tests have been run successfully;
  • Github issue id’s are used in commit messages fixes #23.

Issue Trackers

The issue tracking system is used as task list and issue management system at the same time.

  • We use the github issue tracker;
  • Issues are first registered with github and then resolved;
  • New Features are also registered as issues.

Release and Deployment

  • All projects are continuously integrated with SNAPSHOT versions, but these dependecies can not be used outside of the single project.
  • Projects have an independent release and deployment cycle when possible; but if dependencies are broken then release and deployment is synchronised;
  • External dependencies which are not on the Eclipse standard update sites and not in the Maven Grand Central get a separate feature released indepedently on our update site.

Websites

  • We use github pages and a common infrastructure (add link) for each project’s website.
  • http://www.rascal-mpl.org is the home of Rascal and other (third-party) contributions to the Rascal package ecosystem.
  • http://www.usethesource.io is the home of the UseTheSource organization.

Copyright © 2022, CWI