Giter Club home page Giter Club logo

aggregate-template's Introduction

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

Creek aggregate repo starter

Quickly bootstrap new aggregate repositories and quickly developing Creek microservices.

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

See the docs for more information.

Using this template to create a Creek tutorial

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

  1. Add the new repo to coveralls.io
    1. Enable "Leave comments"
    2. Set "Coverage threshold for failure" to 80
    3. Set "Coverage decrease threshold for failure" to 1
    4. note the repo token.
  2. Customise the repositories settings in GitHub:
    1. General
      1. disable wiki
      2. disable issues
      3. enable discussions
      4. disable projects
      5. only allow squash merging
      6. allow auto-merge
      7. 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. Secrets
      1. Actions: Add the COVERALLS_REPO_TOKEN secret for the repository
      2. Dependabot: Add the COVERALLS_REPO_TOKEN secret for the repository
  3. On the main page in GitHub, in about, set Use your GitHub Pages website.
  4. Add the new tutorial to the tutorials page on creekservice.org
  5. Add the new tutorial sitemap.xml to the root aggregate sitemap.xml: todo

aggregate-template's People

Contributors

big-andy-coates avatar dependabot[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar

aggregate-template's Issues

Switch add_service workflow to create PR, not commit

Currently, the "add service" workflow attempts to commit the code changes directly. The issue with this is that it's not compatible with branch protection. It would be better if the workflow raised the changes as a PR.

Add id module

An Id module, and enhance demos to cover creating type safe id wrappers.

Main CI build fails on multiple commits to main branch

The main CI build fails if there is more than one concurrent commit into the main branch.

To recreate, merge two PRs at the same time, so there are two builds running against the main branch at the same time.

They fail on the publish step because this checks that the repo is synced to HEAD, which it's not.

Update with released jars

Let's get a 0.2 release of all jars out, as it should at least work end-to-end, even if its only the basics.

Document / automate release process.

Get this agg template using none-snapshot jars.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.