Skip to content

Tech debt tasks #102

@ghost

Description

These tasks should be confirmed/performed on each Weaver/Spring Service. This note should be a template for comments of each PR into staging.

  • 1. Standardize the multiple forms of gitignore
  • 2. Standardize README
  • 3. Standardize LICENSE, update date and update pom.xml
  • 4. Standardize PR and Issue templates
  • 5. Upgrade parent project to Weaver-Webservice-Core 2.1.1-RC11
  • 6. Convert all application.properties to application.yml
  • 7. Clean up log files of not being used and ensure used log files are accurate and consistent
  • 8. Maven build utilizes jar profile mvn package -Pjar -DskipTests=true *see pom.xml
  • 9. Update Dockerfile for consistency
  • 10. Update Dockerfile to combine RUN commands for better layer caching
  • 11. Update Dockerfile to use --non-unique to both useradd and groupadd commands.
  • 12. Update Dockerfile RUN build command to utilize jar profile
  • 13. Update GitHub workflow step versions

gitignore

https://github.com/github/gitignore

  1. Default Java gitignore plus common docker files to ignore
  2. Standalone apps (CAP, SAGE, Vireo) with Java, JavaScript gitignore plus common docker and weaver ui files to ignore
  3. Standardize sections for .gitignore (community by project type, docker, application specific)

README

Create multiple md files next to primary README.

  1. README.md
  • badges
  • name
  • overview
  • app repo
  • deployment
  • API documentation
  • license
  1. DEPLOYMENT.md
  • running for development
  • docker for development
  • docker for deployment

PR templates

Template defined for services

Issue templates

Issues regarding intended purpose of client repositories.

  1. bug template
  2. feature template

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions