Skip to content
/ specmesh-template Public template

Template repositories for users to quickly bootstrap new repositories.

License

Notifications You must be signed in to change notification settings

specmesh/specmesh-template

Repository files navigation

License Coverage Status build CodeQL OpenSSF Scorecard <!--- init:remove --->

SpecMesh Template Repository

A template repositories for users to quickly bootstrap new repositories.

Click the Use this template to create a new repository from this template.

Once the bootstrap workflow has completed, pull down locally and run the .specmesh/clean_up.sh script, committing the changes.

Using this template to create a SpecMesh tutorial or demo

If using this template to create a new Creek Tutorial, then there are some additional steps required:

  1. Customise the repositories settings in GitHub:
    1. General
      1. disable wiki
      2. enable discussions
      3. only allow squash merging
      4. allow auto-merge
      5. auto delete branches
    2. Branches
      1. Protect main branch
        1. Require PR
          1. Require approval
          2. Dismiss stale
        2. Require status checks
          1. CodeQL
          2. build
          3. build_pages
          4. coveralls
    3. Pages
      1. Build from actions
      2. enforce https
    4. Coverage
      1. Add the repo to coveralls.io
      2. Set the COVERALLS_REPO_TOKEN secret in GitHub for the repository
  2. Add the new tutorial to the SpecMesh website